showHelp

showHelp(): Boolean;

Call the showHelp method on a Window class object to invoke Windows help on that object if its helpKeyword or helpContextId property is set.

The helpFile property of the application determines the help file that is used. This method returns true if Windows help was initiated or false if it was not (that is, the Window class object had no help information).

When help is invoked directly via the Window class showHelp method or via the user pressing the help key (F1), a URL is created and the default browser is invoked to display the URL if the helpFile property or the Window class helpKeyword property is set to a base URL.

If the helpKeyword property was set, a partial key search is performed using that keyword. If the helpKeyword property is not set but the helpContextId property is set, that context id is used to access the help file.

The method in the following example shows the use of the showHelp method.

buttonHelp_click(btn: Button input) updating;
begin
    if listBoxMethods.text.pos ("::", 1) = null then
        helpKeyword := listBoxMethods.text;
    else
        helpKeyword := listBoxMethods.text[(listBoxMethods.text.pos
                                     ("::",1)+ 2) : end];
    endif;
    showHelp;
end;