Prev | Next |
EA_ShowHelp
Add-Ins can use the EA_ShowHelp event to show a Help topic for a particular menu option. When the user has an Add-In menu option selected, pressing
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.
Syntax
Sub EA_ShowHelp (Repository as EA.Repository, MenuLocation As String, MenuName as String, ItemName as String)
The EA_ShowHelp function syntax contains these parameters.
Parameter |
Type |
See also |
---|---|---|
Repository |
EA.Repository Direction: IN Description: An EA.Repository object representing the currently open Enterprise Architect model. Poll its members to retrieve model data and user interface status information. |
Repository Class |
MenuLocation |
String Direction: Description: A string representing the part of the user interface that brought up the menu. This can be Treeview, MainMenu or Diagram. |
|
MenuName |
String Direction: Description: 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. |
|
ItemName |
String Direction: Description: The name of the option actually clicked; for example, 'Create a New Invoice'. |
Return Value
None.