HELPTOPIC Property

9.4B, PLBCMP GUI Only

The HELPTOPIC property allows specification of a help keyword string for a given GUI object such that a help topic window can be activated when a F1 key is entered with the Windows help enabled. The property uses the following format:

HELPTOPIC={string}

Note the following:

HELPTOPIC may be used in CREATE, SETPROP, or GETPROP statements.
If the HELPTOPIC property string is NULL, the help topic is removed from the object.
The HELPTOPIC property string invokes a Windows help topic window from a '.chm' help file when a F1 key is pressed while the focus is on a given object and the Windows help is enabled for a PLB program.
The HELPID property value invokes a Windows help windows when the HELPID value matches the help context value defined in a '.chm' or '.hlp' when a F1 key is pressed while the focus is on a given object and the Windows help is enabled for a PLB program. The '.hlp' help format is not supported for Windows versions VISTA and later.
If the both the HELPTOPIC and HELPID properties have been set, the HELPTOPIC property takes precedence over the HELPID property. However, if the HELPTOPIC operation fails and the HELPID has been set, the HELPID value is used in an attempt to invoke a help window using a help context value. In this case, a failure for a HELPTOPIC operation means that the Windows help api failure to be execute.
If the HELPTOPIC keyword string is not found in a '.chm' help file, the Windows help is activated with an appropriate invalid page message.
The maximum length for a HELPTOPIC keyword string is 255 bytes.
The F1HELP mode must be active before help is displayed.
System help is not supported by the PLBCE runtime.