Show: Delphi C++
Display Preferences

How TApplication Processes VCL Help

From RAD Studio XE2
Jump to: navigation, search

Go Up to Enabling Help in Applications

The VCL Vcl.Forms.TApplication class provides 4 methods that are accessible from application code:

  • HelpCommand --takes a Windows Help-style HELP_COMMAND and passes it off to the external help viewer application, interfaced in the package specified in the uses clause of your application. Help requests forwarded through this mechanism are passed only to implementations of ISpecialWinHelpViewer.
For Windows HTML help, you should specify the Vcl.HtmlHelpViewer unit. The 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 HTMLHelp or other native Help-handling functions and about the data passed to them, see the appropriate HTMLHelp topics in the MSDN Library.
  • HelpContext --invokes the Help System with a request for context-based Help.
  • HelpKeyword --invokes the Help System with a request for keyword-based Help.
  • HelpJump --requests the display of a particular topic.

All 4 functions take the data passed to them and forward it through a data member of TApplication, which represents the Help system. That data member is directly accessible through the Vcl.Forms.TApplication.HelpSystem property.

See Also

Personal tools
Previous Versions
In other languages