helpKeyword

Type: String

Availability: Read or write at any time

The helpKeyword property of the Window class contains the text used to access the help file. If a help keyword is provided for a form, control, or menu, this text is used to access the help file when the user presses the F1 function key for help while the focus is on that object.

The current keyword is the value of the helpKeyword property for the object that has the focus.

In the Window and MenuItem classes, this property can be translated when the value of the Schema class formsManagement property is FormsMngmt_Single_Multi (2).

For a control, if the helpKeyword property is empty and its helpContextId property is set to zero (0), 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 helpKeyword property is empty and its helpContextId property is set to zero (0) for the parent window, the grandparent window is examined and so on, until the form is reached.

If no help keyword or context number can 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. If the helpContextId property is also set, the helpKeyword value is used in preference to the context number.

Building a help file requires the appropriate third-party tool (that is, the Adobe Acrobat application, Microsoft Windows Help Compiler, or any other Windows help compiler).

When help is requested, if the help file specifies a: