TApplication.DoOnHelp function
Signals an OnHelp event handler.
Declaration
function DoOnHelp(Command: Word; Data: PtrInt; var CallHelp: Boolean)
: Boolean; virtualArguments
Command | Help command to handle in the event handler(s). |
Data | Pointer to the help data used in the event handler(s). |
CallHelp | True to signal a help handler in the form. False if the Help request is handled by the application. |
Function result
True when the message was handled.Description
Signals the OnHelp message handler. DoOnHelp tries the OnHelp handlers for the active form and the Application, as well as handler routines added for the ahtHelp handler type.
The CallHelp argument indicates if handler(s) in the
Application instance should be called when the event handler in
the form is completed. Set CallHelp to False when the help request has
been satisfied in one of the event handlers.
DoOnHelp is called from the HelpCommand method.
See also
An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.