Vcl.WinHelpViewer

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

WinHelp 関数 API のラッパーを実装します。 WinHelpViewer ユニットは廃止予定のです。代わりに、Vcl.HtmlHelpViewer を使用してください。

パッケージ vcl.bpl

クラス

IWinHelpTester

このインターフェイスのメソッドを使用して、Windows WinHelp ヘルプ API 関数への要求に使用できる、ヘルプ ファイルやキーワード リスト、ALink、コンテキスト ID、ヘルプ トピックを保守し分析することができます。
VCL ではこのインターフェイスの実装を提供していません。その機能をサポートしたい場合には、アプリケーションで IWinHelpTester を実装する必要があります。

変数

ViewerName

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

WinHelpTester

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


説明

WinHelpViewer ユニットは、Windows の WinHelp 関数 API のラッパーを実装します。Microsoft には、廃止予定の WinHelp があります。WinHelp は、Windows Vista や Windows 7 では提供されていません。このため、WinHelpViewer ユニットも廃止予定となります。代わりに、Vcl.HtmlHelpViewer を使用してください。

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

To access methods of the private TWinHelpViewer class from other units, the initialization section of this unit creates the HelpViewer object of this class and calls the global System.HelpIntfs.RegisterViewer function to register the Help Manager. The global System.HelpIntfs.GetHelpSystem function, from the HelpIntfs unit, can retrieve Help System objects of the registered HelpViewer. Then code in other units can access methods of the retrieved Help System objects.

To use the WinHelp help viewer in your application, include the WinHelpViewer unit in the uses section of the main unit (or into another proper unit) of your application. However, because Microsoft has deprecated the WinHelp viewer, we recommend that you use Vcl.HtmlHelpViewer instead.

initialization section

The initialization section of the WinHelpViewer unit provides the following initialization:

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

Here:

  • The TWinHelpViewer.Create constructor in the first line internally creates the Help Viewer object HelpViewerIntf of the TWinHelpViewer class and stores it in the HelpViewer variable.
  • The second line calls the global System.HelpIntfs.RegisterViewer function that registers the created Help Viewer.

The global System.HelpIntfs.GetHelpSystem function can be called from other units to access methods of Help Systems from the registered Help Viewer.

See Also