Vcl.Forms.TApplication.HelpFile
Delphi
property HelpFile: string read FHelpFile write FHelpFile;
C++
__property System::UnicodeString HelpFile = {read=FHelpFile, write=FHelpFile};
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| property | public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | TApplication |
Description
Specifies the name of the default Help file the application uses to display the Help from.
Use the HelpFile property to specify the default Help file for an application that uses the VCL Help system.
You can either programmatically assign a Help file name to the HelpFile property of the TApplication type object at run time, or specify a Help file name to the Help file option on the Application Options page of the Project Options dialog box at design time.
The Help system specified by TApplication.HelpSystem displays Help topics from the Help file specified by CurrentHelpFile. HelpFile supplies the value of CurrentHelpFile unless there is a Help file specified by the TForm.HelpFile for the active form.
By default, HelpFile is a null string, and the application's Help method ignores attempts to display the Help unless the active form has an associated Help file.
In order for the Help to work and to call the proper native Help handling function, insert the appropriate Vcl.HtmlHelpViewer, Vcl.WinHelpViewer, or other unit in the uses clause of your application. 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 or WinHelpViewer.hpp header file.