System.HelpIntfs.IExtendedHelpViewer.DisplayHelpByContext

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

Delphi

procedure DisplayHelpByContext(const ContextID: THelpContext;  const HelpFileName: string);

C++

virtual void __fastcall DisplayHelpByContext(const System::Classes::THelpContext ContextID, const System::UnicodeString HelpFileName) = 0 ;

プロパティ

種類 可視性 ソース ユニット
procedure
function
public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs IExtendedHelpViewer


説明

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

ヘルプ システムは DisplayHelpByContext を呼び出して、コンテキスト ベースのヘルプ要求を処理します:

  • ContextID は、ヘルプ トピックの数値のコンテキスト ID です。.chm ヘルプ ファイルの場合、ヘルプ トピックのシンボリック Context ID を、プロジェクト ファイル(.hhp)の [MAP] セクションにある数値の ID にマップしなければなりません。
  • HelpFileName は、トピックを保有するファイルの名前です。ヘルプ エンジンによっては、ファイル名を完全限定パスで、必要とするものもある点に注意してください。

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

関連項目