Vcl.Forms.THelpEvent
Delphi
THelpEvent = function(Command: Word; Data: THelpEventData; var CallHelp: Boolean): Boolean of object;
C++
typedef bool __fastcall (__closure *THelpEvent)(System::Word Command, THelpEventData Data, bool &CallHelp);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
type typedef |
public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | Vcl.Forms |
説明
THelpEvent は、OnHelp イベント ハンドラの型です。
THelpEvent には、次のパラメータがあります：
Command、発行されたヘルプ コマンドの種類を示します。その意味は現在のヘルプ システムが何であるかによって変わります。 たとえば、HTMLHelp を使用している場合、Commandは HTMLHelp API が使用するコマンドになります。使用可能なコマンドの詳細については、MSDN ライブラリの適切な HTMLHelp トピックを参照してください。
Data、ヘルプ システムのアクションを説明する、補足データを提供します。その値は、Commandプロパティの値によって変わります。 通常、Dataにはキーワードやコンテキスト ID が含まれます。 詳細については、MSDN ライブラリの適切な HTMLHelp トピックを参照してください。
CallHelpはイベント ハンドラによって設定されます。 イベント ハンドラが終了したときにCallHelpがtrueであれば、アプリケーションはヘルプ システムにヘルプ コマンドを転送する必要があります。 イベント ハンドラは、コマンドを処理した場合にはCallHelpをfalseに設定し、アプリケーションがヘルプ システムにヘルプ コマンドを転送しないようにします。
OnHelp イベント ハンドラが適切に動作するには、アプリケーションの uses 句に、Vcl.HtmlHelpViewer ユニットまたは他のユニットを挿入します。これらは、使用する外部ヘルプ ビューアへのインターフェイスを提供してくれます。 Vcl.HtmlHelpViewer ユニットは、HTMLHelp Windows ネイティブ ヘルプ処理機能への、Delphi インターフェイスを提供します。 C++ の場合には、HTMLHelpViewer.hpp ヘッダー ファイルをインクルードする必要があります。
ネイティブ ヘルプ処理機能（HTMLHelp やその他）、およびそこへ渡されるデータに関する情報については、適宜、MSDN ライブラリ内の HTMLHelp トピックを参照してください。