EA_ShowHelp

Topics

Topic

Detail

See also

Details

The EA_ShowHelp event enables the Add-In to show a help topic for a particular menu option. When the user has an Add-In menu option selected, pressing ( F1 ) can be related to the required Help topic by the Add-In and a suitable help message shown.

This event is raised when the user presses ( F1 ) on a menu option that is not a parent menu.

 

EA_GetMenuItems

Syntax:

Sub EA_ShowHelp(Repository as EA.Repository, MenuLocation As String, MenuName as String, ItemName as String)

The EA_ShowHelp function syntax contains the following elements:

Parameter

Type

Direction

Description

ItemName

String

 

The name of the option actually clicked, for example, Create a New Invoice.

 

MenuLocation

String

 

A string representing the part of the user interface that brought up the menu. This can be Treeview, MainMenu or Diagram.

 

MenuName

String

 

The name of the parent menu for which sub-items are to be defined. In the case of the top-level menu this is an empty string.

 

Repository

EA.Repository

IN

An EA.Repository object representing the currently open Enterprise Architect model. Poll its members to retrieve model data and user interface status information.

 

Return Value:

None.