helpContextId

Type: Integer

Availability: Read or write at any time

The helpContextId property of the Window class contains an associated context number for an object. This property is used to provide context-sensitive help for your application.

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, or Hypertext Markup Language (.htm or .html) files), when a user presses the F1 function key, JADE automatically calls help 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. For a control, if the helpContextId property is set to zero (0) and the helpKeyword property value is null, JADE examines the corresponding properties on the window that is the parent window of the control, which is either the form or another control. If the helpContextId property is set to zero (0) and the helpKeyword property value is null for the parent window, the grandparent window is examined and so on, until the form is reached.

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 Microsoft Windows Help Compiler or the Adobe Acrobat application.

As PDF files require string values as help destinations, see the PdfHelpIdPrefix parameter under "JADE Help Section [JadeHelp]", in the JADE Initialization File Reference for details about formatting a helpContextId property into a string value.