Vcl.AppEvnts.TCustomApplicationEvents.OnHelp
Delphi
property OnHelp: THelpEvent read FOnHelp write FOnHelp;
C++
__property Vcl::Forms::THelpEvent OnHelp = {read=FOnHelp, write=FOnHelp};
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
event | protected | Vcl.AppEvnts.pas Vcl.AppEvnts.hpp |
Vcl.AppEvnts | TCustomApplicationEvents |
説明
アプリケーションが、ヘルプに対するリクエストを受け取った際に発生します。
OnHelp イベント ハンドラを記述すると、ユーザーがヘルプを要求した際に、特別な処理を実行させることができます。 HelpContext および HelpJump メソッドは、OnHelp イベントを自動的に発生させます。
THelpEvent 型には、次のパラメータがあります: CallHelp
、Command
、Data
。
アプリケーションがイベントの後でもヘルプ システムを呼び出す必要がある場合には、CallHelp
を true
に設定します。 ヘルプ システムによるデフォルトの応答を抑制する場合には、CallHelp
を false
に設定します。 アプリケーションのヘルプ メソッドはすべて、OnHelp を通ります。 アプリケーションは、OnHelp の CallHelp
パラメータが true
の場合、または、OnHelp イベント ハンドラが割り当てられていない場合にのみ、ヘルプ システムを呼び出します。
イベント ハンドラは、処理が成功した場合には True を、失敗した場合には、False を返します。
Data
パラメータに対して設定可能な値は、Command
パラメータの値によって変わります。 Command
および Data
パラメータで使用可能な値を知るには、MSDN ライブラリの該当する HTMLHelp トピックを参照してください。
OnHelp イベント ハンドラが適切に動作するには、アプリケーションの uses 句に、Vcl.HtmlHelpViewer ユニットまたは他のユニットを挿入します。これらは、使用する外部ヘルプ ビューアへのインターフェイスを提供してくれます。 Vcl.HtmlHelpViewer ユニットは、HTMLHelp Windows ネイティブ ヘルプ処理機能への、Delphi インターフェイスを提供します。 C++ の場合には、HTMLHelpViewer.hpp ヘッダー ファイルをインクルードする必要があります。
メモ: OnHelp イベント ハンドラから CancelDispatch メソッドを呼び出すと、アプリケーションがそのイベントを他のアプリケーション イベント オブジェクトに送るのを抑制することができます。
関連項目
- Vcl.Forms.TApplication.HelpCommand
- Vcl.Forms.TApplication.HelpContext
- Vcl.Forms.TApplication.HelpFile
- Vcl.AppEvnts.TCustomApplicationEvents.CancelDispatch
- Vcl.Forms.TApplication.HelpJump