This statement sets the default help context number for all objects that do not have a value set in the Help Context property. Equinox usually displays its own files when on-line help is selected. However, if you have an Equinox Publisher Edition licence, you can override this behaviour by checking the "Enable default help" option on the Display tab of the Software settings.

You can then use the SetDefaultHelp statement and/ or the Help Context property of form objects, to launch your own topics when on-line help is selected. Valid values for ContextNumber are integers in the range [1 to 16383]. Changes made using this statement remain in effect until either the application is closed, or another SetDefaultHelp statement is executed.

In addition to providing a default number for all the objects that do not have a help context, you can also override the internal context numbers used by Equinox dialogs by setting the OverrideEquinox argument. If omitted, this parameter retains the last value set. This value will be 0, unless it has been overridden since the start of application. OverrideEquinox may take one the following values:

• -1 Disable help (use 0 to re-enable)
• 0 Use Equinox context numbers and user context numbers
• 1 Ignore all context numbers except the default
• 2 Ignore Equinox context numbers

The SysError system workarea will return a value of -1 if there is problem executing this statement (usually because the "Enable default help" option is not checked on the Display tab of the Software settings).

This example sets the default help context number to one, for all objects on a form that do not have any value set in the Help Context property. It also overrides all the internal context numbers used by Equinox dialogs.

SetDefaultHelp 1, 2