Vcl.HtmlHelpViewer

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

Windows HTMLHelp 関数 API のラッパーを実装します。

パッケージ vcl290.bpl

クラス

IHtmlHelpTester

このインターフェイスのメソッドを使用して、Windows HTMLHelp ヘルプ API 関数への要求に使用できる、ヘルプ ファイルやキーワード リスト、ALink、コンテキスト ID、ヘルプ トピックを保守し分析することができます。

変数

HtmlHelpTester

HtmlHelpTester 変数には、作成された IHtmlHelpTester 型のオブジェクトが格納されます。

ViewerName

ViewerName 変数には、登録ビューアの中からこのビューアを特定するためにヘルプ マネージャが使用できる文字列が格納されます。

説明

HtmlHelpViewer ユニットは、Windows の HTMLHelp 関数 API にラッパーを提供する外部ヘルプ ビューアを実装します。このユニットの設計ゴールは、VCL ヘルプ マネージャが判別する場合、他の外部ヘルプ ビューアと同じように見えるようにすることです。それに応じて、System.HelpIntfs ユニットで実装されるヘルプ システムによって使用される HTMLHelp API のそれらの機能のみをラッピングしています。

HtmlHelpViewer は、implementation セクションで宣言されている、private THtmlHelpViewer クラスの HTMLHelp API 機能をラッピングしています。THtmlHelpViewer クラスは、System.HelpIntfs ユニットで宣言されているヘルプ インターフェイスを実装しています。System.HelpIntfs は、ヘルプ システムが、アプリケーションでのヘルプ リクエストと、HTMLHelp のような外部ヘルプ ビューア間で通信できるようにする、一連のインターフェイス群を提供しています。

他のユニットから、private THtmlHelpViewer クラスのメソッドにアクセスするには、このユニットの initialization セクションで、このクラスの HelpViewer オブジェクトを作成し、グローバル関数 System.HelpIntfs.RegisterViewer を呼び出してヘルプ マネージャに登録します。グローバル関数 System.HelpIntfs.GetHelpSystemSystem.HelpIntfs ユニット内)は、登録された HelpViewer のヘルプ システム オブジェクトを取得することができます。これで、他のユニット内のコードから、取得したヘルプ システム オブジェクトのメソッドにアクセスできるようになります。

アプリケーションで HTMLHelp ヘルプ ビューアを使用するには、HtmlHelpViewer ユニットを、アプリケーションのメイン ユニット(もしくは、他の適切なユニット)の uses セクションでインクルードします。

initialization セクション

HtmlHelpViewerinitialization セクションでは、次の初期化を提供します:

 HelpViewer := THtmlHelpViewer.Create;
 HelpIntfs.RegisterViewer(HelpViewerIntf, HelpViewer.FHelpManager);

ここでは:

  • 1 行目の THtmlHelpViewer.Create コンストラクタで、THtmlHelpViewer クラスのヘルプ ビューア オブジェクト HelpViewerIntf を内部的に作成し、HelpViewer 変数に格納します。
  • 2 行目では、グローバル関数 System.HelpIntfs.RegisterViewer を呼び出して、作成したヘルプ ビューアを登録します。

グローバル関数 System.HelpIntfs.GetHelpSystem は、他のユニットから呼び出して、登録されたヘルプ ビューアのヘルプ システムのメソッドにアクセスすることができます。

関連項目