Context help

Syntax

Context help {command (parameters)}

Description

This command provides context help to the user: note this only applies to fat client or desktop apps, not web & mobile apps created using the JavaScript Client.

You specify a command mode option, and depending on the mode you can specify the help file name and context id. The command mode options are constants listed in the Catalog.

kHelpContextMode
initiates context help mode, showing a ‘?’ cursor.

kHelpContext (’helpfile name’, context id)
opens a general help window for the topic specified.

kHelpContextPopup (’helpfile name’, context id)
opens a popup help window for the topic specified.

kHelpContents (’helpfile name’)
opens the help file at the contents page.

kHelpQuit (’helpfile name’)
closes window mode help.

Some options do not work on all platforms.

To implement context help for an object or area, you set the help id as a decimal value in the $helpid property of a class or object, including windows, menus, and toolbars. You can make your custom help file which must be placed in the Help folder and the name entered in the library preference property $clib.$prefs.$helpfilename.

When the user clicks on an object with the help cursor or presses the F1/Help key, Omnis looks for the help id. If it finds none for a window object, menu line, or toolbar control, it then looks in the next higher containing object.

Example

# Show the file index.htm from the omnis help folder
# in the standard help window 
Context help {kHelpContext ('omnis','index')}
# Show ? cursor and awaits click, when user clicks, shows a popup 
# window with topic $cobj.$helpid from $clib.$prefs.$helpfilename 
# located in the Help folder 
Context help {kHelpContextMode}