Vcl.Forms.TApplication.HelpKeyword

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

Delphi

function HelpKeyword(const Keyword: string): Boolean;

C++

bool __fastcall HelpKeyword(const System::UnicodeString Keyword);

プロパティ

種類 可視性 ソース ユニット
function public
Vcl.Forms.pas
Vcl.Forms.hpp
Vcl.Forms TApplication


説明

キーワードで指定されたヘルプ トピックを表示します。

HelpKeyword を使用すると、Keyword パラメータを持ち、CurrentHelpFile プロパティで指定されるファイルからのものである、ヘルプ トピックを表示します。HelpKeyword は、現在のヘルプ システムを呼び出し、Keyword で指定された文字列を渡します。現在のヘルプ システムが HTMLHelp(または WinHelp)の場合、これは、Keyword に等しい Alink タグを持つ、ヘルプ トピックを表示します。

HelpKeyword は、現在のヘルプ システムがキーワード検索をサポートしていない場合に、False を返します。

ヘルプが適切に動作するには、アプリケーションの uses 句に、Vcl.HtmlHelpViewer ユニットまたは他のユニットを挿入します。これらは、使用する外部ヘルプ ビューアへのインターフェイスを提供してくれます。 Vcl.HtmlHelpViewer ユニットは、HTMLHelp Windows ネイティブ ヘルプ処理機能への、Delphi インターフェイスを提供します。 C++ の場合には、HTMLHelpViewer.hpp ヘッダー ファイルをインクルードする必要があります。

ネイティブ ヘルプ処理機能(HTMLHelp やその他)、およびそこへ渡されるデータに関する情報については、適宜、MSDN ライブラリ内の HTMLHelp トピックを参照してください。

関連項目