Delphi Learn About The HelpJump Method For Displaying Help

FireWind

Свой
Регистрация
2 Дек 2005
Сообщения
1,957
Реакции
1,199
Credits
4,009
Learn About The HelpJump Method For Displaying Help
By Muhammad Azizul Hakim September 24, 2021

Use the HelpJump method or DelphiVCL.Application.HelpJump to display the Help topic specified by the symbolic name.

More things about HelpJump you need to know​

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 the 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 the 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.

How to use DelphiVCL.Application.HelpJump properly?​

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.

How to find details on all the properties and methods of the DelphiVCL.Application.HelpJump?​

Let’s browse all the properties, methods, and built-in properties of the DelphiVCL.Application.HelpJump using dir() command:
Python:
import DelphiVCL
 
dir(DelphiVCL.Application.HelpJump)
See the responses in our Windows command prompt:
1632493286784.png
You can also read short information about the DelphiVCL.Application.HelpJump using the print() command:
Python:
print(DelphiVCL.Application.HelpJump)
print(DelphiVCL.Application.HelpJump.__doc__)
See the responses in our Windows command prompt:
1632493319278.png