Vcl.Forms.TApplication.HelpJump
Delphi
function HelpJump(const JumpID: string): Boolean;
C++
bool __fastcall HelpJump(const System::UnicodeString JumpID);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | TApplication |
説明
シンボリック名で指定されたヘルプ トピックを表示します。
HelpJump を呼び出すと、JumpID シンボリック名で識別されるトピックが、CurrentHelpFile プロパティで指定されるヘルプ ファイルから立ち上がります。
HelpJump は、OnHelp イベントを生成します（アクティブなフォームか、アプリケーション オブジェクト自身に対して）。 OnHelp イベント ハンドラがない場合、または、イベント ハンドラがネイティブのヘルプ処理機能を呼び出すよう指示した場合、HelpJump はネイティブの HTMLHelp（または WinHelp）ヘルプ処理機能を呼び出し、それに JumpID シンボリック名を渡します。.chm ヘルプ ファイルの場合、JumpID は、そのトピックを含むソース .htm ファイルの名前になります。
HelpJump は、CurrentHelpFile が空文字列の場合、つまり、アプリケーションにヘルプ ファイルが割り当てられていない場合に、False を返します。 そのほかの場合はすべて、HelpJump は True を返します。
HelpJump が動作し、適切なネイティブのヘルプ処理機能を呼び出すにはアプリケーションの uses 句に、Vcl.HtmlHelpViewer ユニットまたは他のユニットを挿入します。これらは、使用する外部ヘルプ ビューアへのインターフェイスを提供してくれます。 Vcl.HtmlHelpViewer ユニットは、HTMLHelp Windows ネイティブ ヘルプ処理機能への、Delphi インターフェイスを提供します。 C++ の場合には、HTMLHelpViewer.hpp ヘッダー ファイルをインクルードする必要があります。
ネイティブ ヘルプ処理機能（HTMLHelp やその他）、およびそこへ渡されるデータに関する情報については、適宜、MSDN ライブラリ内の HTMLHelp トピックを参照してください。