EA_ShowHelp

Return to Introduction  Previous page  Next page

The EA_ShowHelp 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 delegated to the required Help topic by the Add-In and a suitable help message shown. .

 

Syntax

 

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

 

The EA_GetMenuItems function syntax contains the following elements

 

 

Parameter

Type

Direction

Description

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.

MenuLocation

String

 

String representing the part of the user interface that brought up the menu. 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 it is an empty string.

ItemName

String

 

The name of the option actually clicked, eg. "Create &New Invoice".

 

Return Value

 

None.

 

Details

 

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

See Also

·     EA_GetMenuItems