helpContextId

Type: Integer

Availability: Read or write at any time

The helpContextId property of the MenuItem class contains an associated context number for a menu item object. This property is used to provide context-sensitive help for your menu. If the helpKeyword property is also set, the keyword is used in preference to the context number.

For context-sensitive help on an object in your application, you must assign the same context number to both the object and to the associated help topic when you compile your help file.

If you have created a Windows environment help file for your application (that is, a .hlp or .chm file), JADE automatically calls help when a user presses F1 and requests the topic identified by the current context number (or the helpKeyword property).

The current context number is the value of the helpContextId property for the object that has the focus or the selected menu item. If this property is set to zero (and its helpKeyword property value is null), JADE looks in the helpContextId property (and the helpKeyword property) of the form of the object. If a non-zero current context number cannot be found, the Contents section of the help file is requested. If the helpFile property of the Application class is not set, no help file is opened.

Building a help file requires the Adobe Acrobat application, Microsoft Windows Help Compiler, or any other Windows help compiler.