Sign in Join
FPDoc Onlineexperiment

THelpEvent procedure type

In unit Forms

Type used for an OnHelp event handler.

Declaration

pascal
THelpEvent = function(Command: Word; Data: PtrInt; 
 var CallHelp: Boolean): Boolean of object

Arguments

Command

Help command type requested; either HELP_CONTEXT or HELP_COMMAND.

Data

Context data for the help request.

CallHelpFalse suppresses help display.

Function result

Indicates if the help request is satisfied by the event handler; False causes the default help handler for the application to be used.

Description

THelpEvent is an object function which specifies an event handler signalled when Help is requested in an application or form. THelpEvent is the type used to implement the OnHelp event handler in TCustomForm and TApplication. Applications must implement a function using the signature for the event handler, and assign it to the property.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.