Vcl.Forms.TApplication.HelpFile

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

property HelpFile: string read FHelpFile write FHelpFile;

C++

__property System::UnicodeString HelpFile = {read=FHelpFile, write=FHelpFile};

プロパティ

種類 可視性 ソース ユニット
property public
Vcl.Forms.pas
Vcl.Forms.hpp
Vcl.Forms TApplication


説明

ヘルプ フォームを表示するためにアプリケーションが使用する、デフォルト ヘルプ ファイルの名前を示します。

HelpFile プロパティを使用すると、VCL ヘルプ システムを使用するアプリケーションの、デフォルト ヘルプ ファイルを指定することができます。

Help ファイル名は、実行時に TApplication 型オブジェクトの HelpFile プロパティに、プログラムで割り当てるか、設計時に、プロジェクト オプションダイアログボックスにあるアプリケーションページのヘルプ ファイルオプションで、指定します。

TApplication.HelpSystem で指定されたヘルプ システムは、CurrentHelpFile で指定されたヘルプ ファイルから、ヘルプ トピックを表示します。HelpFile は、アクティブ フォームの TForm.HelpFile でヘルプ ファイルが指定されていない場合に、CurrentHelpFile の値を提供します。

デフォルトの HelpFile は null 文字列で、その場合、アプリケーションの Help メソッドは、アクティブ フォームにヘルプ ファイルが関連付けられていなければ、ヘルプの表示試行を無視します。

ヘルプが動作し、適切なネイティブのヘルプ処理機能を呼び出すには、アプリケーションの uses 句に、適切な Vcl.HtmlHelpViewerVcl.WinHelpViewer、または他のユニットを挿入する必要があります。Vcl.HtmlHelpViewer ユニットは、HTMLHelp Windows ネイティブ ヘルプ処理機能への、Delphi インターフェイスを提供します。 C++ の場合、ヘッダー ファイル HTMLHelpViewer.hpp または WinHelpViewer.hpp をインクルードする必要があります。

関連項目

コード サンプル