Menu Help

You can specify the help symbol and appID for a menu by setting the hiHelpSymName and hiHelpAppName properties on the menu symbol. You can use the putprop() function to set the properties. For example:

putprop( ’myMenuSymbol "MyHelpSymbol" ’hiHelpSymName)

putprop( ’myMenuSymbol "MyApp" ’hiHelpAppName)

When a user selects a menu and presses the Help key (or the F1 key if the keyboard does not have a Help key), hiHelp() is called. The help that is invoked applies to the entire menu, not just to a menu item.

hiHelp() checks the menu symbol for the hiHelpSymName and hiHelpAppName properties. If the hiHelpSymName property is set, its value is used as the help symbol. Otherwise the menu symbol is used as the help symbol.

If the hiHelpAppName property is set, its value is used as the appID. If the property is not set or its value is nil, hiHelp() calls hiGetAppType() to get the application name of the current window, which it uses as the appID. If the application name on the current window is nil, hiHelp() uses dfii as the appID.

Related Topics

Properties Required for Task Assistant

Return to top