Vcl.Forms.TApplication.CurrentHelpFile

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property CurrentHelpFile: string read GetCurrentHelpFile;

C++

__property System::UnicodeString CurrentHelpFile = {read=GetCurrentHelpFile};

Properties

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

Description

Indicates the current Help file.

Read CurrentHelpFile to determine the name of the Help file that is currently used by the application when it executes a Help command (through the HelpCommand method) or when it brings up context-sensitive Help (through the HelpContext or HelpJump method). If CurrentHelpFile is an empty string, the application ignores the attempts to display Help.

The Help system specified by 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 TForm.HelpFile for the active form. Then the Help file from TForm.HelpFile is used.

See Also