Vcl.Forms.TApplication.HelpJump
Delphi
function HelpJump(const JumpID: string): Boolean;
C++
bool __fastcall HelpJump(const System::UnicodeString JumpID);
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | TApplication |
Description
Displays the Help topic specified by the symbolic name.
Call HelpJump to bring up a topic identified by its JumpID symbolic name and which is from the Help file specified in the CurrentHelpFile property.
HelpJump generates an OnHelp event (either on the active form or on the application object itself). If there is no OnHelp event handler or if the event handler indicates that native Help handling function should be called, then HelpJump invokes the native HTMLHelp (or WinHelp) Help handling function, passing to it the JumpID symbolic name.
In case of a .chm help file, JumpID should be the name of the source .htm file containing the topic.
HelpJump returns False if CurrentHelpFile is an empty string, meaning the application has no Help file assigned. In all other cases, HelpJump returns True.
In order for HelpJump to work and to call the proper native Help handling function, insert in the uses clause of your application the Vcl.HtmlHelpViewer or another unit that provides an interface to the external Help viewer to use. The Vcl.HtmlHelpViewer unit provides a Delphi interface to the HTMLHelp Windows native Help handling function. For C++, you need to include the HTMLHelpViewer.hpp header files.
For information about the native Help handling functions (HTMLHelp or other) and about the data passed to them, see the appropriate HTMLHelp topics in the MSDN Library.