RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TApplication.HelpJump Method

Displays a specified help topic.

Pascal
function HelpJump(const JumpID: string): Boolean;
C++
__fastcall Boolean HelpJump(const AnsiString JumpID);

Call HelpJump to bring up a topic identified by its symbolic name. HelpJump displays the topic identified by the JumpID parameter from the file specified in the Current HelpFile 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 WinHelp should be called, then HelpJump invokes the Windows help engine, passing it the topic name. 

HelpJump returns false if CurrentHelpFile is an empty string, meaning the application has no help file assigned. In all other cases, HelpJump returns true. 

 

Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!