Vcl.Forms.TApplication.HelpSystem

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property HelpSystem: IHelpSystem read FHelpSystem;

C++

__property System::Helpintfs::_di_IHelpSystem HelpSystem = {read=FHelpSystem};

Properties

Type Visibility Source Unit Parent
property public
Vcl.Forms.pas
Vcl.Forms.hpp
Vcl.Forms TApplication

Description

Provides access to the interface for working with the Help system.

TApplication uses IHelpSystem to interact with a Help system manager. This interface includes methods for displaying Help topics based on a keyword or topic ID.

Applications can use the HelpSystem property to interact directly with the Help system manager, or they can use the application's Help-oriented methods such as HelpCommand and HelpJump.

In order for the Help to work properly, 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.

See Also