System.HelpIntfs.IHelpSystem3.ShowIndex

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

Delphi

procedure ShowIndex(const Topic, HelpFileName: string);

C++

virtual void __fastcall ShowIndex(const System::UnicodeString Topic, const System::UnicodeString HelpFileName) = 0 ;

プロパティ

種類 可視性 ソース ユニット
procedure
function
public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs IHelpSystem3

説明

ヘルプ ビューアのキーワードペインを開きます。

RTL ヘルプ システムは ShowIndex メソッドを呼び出して、ビューアにそのキーワードペインを開けさせます。 ヘルプ ビューアに指定されたトピック パラメータの検索機能がある場合、キーワード検索を実行します。ない場合、検索は実行されません。 HelpFileName パラメータは、特定のヘルプ システム (例えば Microsoft の HTML ヘルプなど) の中でのみ使用され、またヘルプ システムがすべてのヘルプ ファイル名をあらかじめ認識していない場合にのみ使用されます。

ヘルプ システムは、登録されているすべてのヘルプ ビューアに問い合わせをします。 キーワードペインを表示できるビューアが 1 つだけの場合は、そのビューアが表示されます。そうでない場合、どのビューアを表示したいのかを聞かれます。

関連項目