Vcl.Forms.TApplication.HelpContext

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

Delphi

function HelpContext(Context: THelpContext): Boolean;

C++

bool __fastcall HelpContext(System::Classes::THelpContext Context);

プロパティ

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


説明

数値のコンテキスト識別子で指定されたヘルプ トピックを表示します。

HelpContext を使用すると、数値のコンテキスト識別子 Context パラメータで指定されるヘルプ トピックを、CurrentHelpFile プロパティで指定されるファイルから表示します。 HelpContext は、OnHelp イベントを生成します(アクティブなフォームか、アプリケーション オブジェクト自身に対して)。OnHelp イベント ハンドラがない場合、または、イベント ハンドラが HTMLHelp を呼び出すよう指示した場合、HelpContextHTMLHelp Windows ヘルプ エンジンを呼び出し、Context パラメータで指定されたコンテキスト ID を渡します。

たとえば、Context 値が 714 の場合、HelpContext メソッドは、CurrentHelpFile で指定されるヘルプ ファイル内の、コンテキスト ID 714 のヘルプ トピックを表示します。.chm ヘルプ ファイルの場合、ヘルプ トピックのシンボリック Context ID を、プロジェクト ファイル(.hhp)の [MAP] セクションにある、数値の Context 値にマップしなければなりません。

HelpContext は、CurrentHelpFile が空文字列の場合、つまり、アプリケーションにヘルプ ファイルが割り当てられていない場合に、False を返します。そのほかの場合はすべて、HelpContextTrue を返します。

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

ネイティブ ヘルプ処理機能(HTMLHelp やその他)、およびそこへ渡されるデータに関する情報については、適宜、MSDN ライブラリ内の HTMLHelp トピックを参照してください。

関連項目