RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TForm.OnHelp Event

Occurs when the form receives a request for help.

Pascal
property OnHelp: THelpEvent;
C++
__property THelpEvent OnHelp;

Write an OnHelp event handler to perform special processing when the user requests help. The HelpContext and the HelpJump methods automatically trigger the OnHelp event.  

Set the CallHelp parameter to true if the application should still invoke the help system after the event. Set CallHelp to false to prevent the default response by the help system. The form calls the help system only if OnHelp's CallHelp parameter returns true or if no OnHelp event handler is assigned. 

To find the possible values of the Command and Data parameters, search for WinHelp in the Win32 Developer's Reference Help (Win32.HLP) file, which explains the WinHelp API (application programming interface). The possible values for the Data parameter depend upon the value of the Command parameter. 

The event handler returns true if it succeeds, false if it fails. 

 

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!