System.HelpIntfs.IHelpSelector.SelectKeyword
Delphi
function SelectKeyword(Keywords: TStrings) : Integer;
C++
virtual int __fastcall SelectKeyword(System::Classes::TStrings* Keywords) = 0 ;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | IHelpSelector |
説明
複数のビューアについてのキーワードベースのヘルプサポートを提供します。
ヘルプシステムは，キーワードベースのヘルプリクエストに一致するトピックを持つヘルプビューアが複数ある場合に SelectKeyword を呼び出します。Keywords パラメータには，ビューアごとに GetHelpStrings を呼び出して取得されたヘルプ文字列のマージリストが含まれます。SelectKeyword は，特定のヘルプ文字列のインデックスを返すことにより，特定のトピックを示します。次に，ヘルプシステムはそのヘルプ文字列を適切なビューアの ShowHelp メソッドに渡します。戻り値が負の場合，ヘルプシステムはヘルプリクエストが中止されたものとみなし，何も行いません。
通常，SelectKeyword はダイアログボックスを表示して，ユーザーがヘルプ文字列のいずれかを選択できるようにし，ユーザーが選択したインデックスを返すか，ユーザーがダイアログをキャンセルした場合は負の値を返します。これと同様の機能はほとんどのビューアに備わっています。これにより，ユーザーは一致するすべてのトピックを単一のリストで見ることができます。
メモ： SelectKeyword では，ヘルプ文字列のリストの変更またはソートは行わないでください。