System.HelpIntfs.ICustomHelpViewer.GetHelpStrings
Delphi
function GetHelpStrings(const HelpString: string): TStringList;
C++
virtual System::Classes::TStringList* __fastcall GetHelpStrings(const System::UnicodeString HelpString) = 0 ;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | ICustomHelpViewer |
説明
キーワードに一致するヘルプ文字列を返します。
ヘルプ システムは、GetHelpStrings を呼び出して、キーワードをベースとしたヘルプに対するリクエストに合致するトピック群を表す、ヘルプ文字列のリストを取得します。 GetHelpStrings は、HelpString パラメータにキーワードが指定されていることを想定しており、TStringList オブジェクトにヘルプ文字列を返します。
ヘルプ文字列とは、特定のトピックに関連づけられ、それらを識別するための文字列です。 ヘルプ システムでは、所定のビューアが提供する各トピックごとに、異なるヘルプ文字列が関連付られている必要があります。 一方で、ヘルプ システムでは、2 つのビューアが同じヘルプ文字列を使用していても構いませんが、アプリケーションでは同じヘルプ文字列を使用しないようにする必要があります。 解決策の 1 つとして、ヘルプ文字列に、ビューア名を付加する方法があります。
ヘルプ システムは、ヘルプ文字列を使用して、リクエストに一致するヘルプ トピックのマージ リストを、ヘルプ セレクタに提供します。 通常、ヘルプ文字列は人が読める形式のトピックの説明であり、ヘルプ セレクタは、単純にそれらをユーザーに表示することにより、ユーザーはどのトピックを表示されるか選択することができます。
GetHelpStrings を使用するには、アプリケーションの uses 句に、Vcl.HtmlHelpViewer ユニットまたは他のユニットを挿入します。これらは、使用する外部ヘルプ ビューアへのインターフェイスを提供してくれます。 C++ の場合には、HTMLHelpViewer.hpp ヘッダー ファイルをインクルードする必要があります。