System.HelpIntfs.IExtendedHelpViewer.UnderstandsTopic
Delphi
function UnderstandsTopic(const Topic: string): Boolean;
C++
virtual bool __fastcall UnderstandsTopic(const System::UnicodeString Topic) = 0 ;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | IExtendedHelpViewer |
説明
ヘルプ ビューアに、指定された Topic 文字列が解釈可能か、問い合わせます。
UnderstandsTopic は、ヘルプ ビューアが、Topic パラメータで提供されるトピック名のトピックを識別できる場合には True を返す必要があります。
Topic は、特定のヘルプ ビューアで維持されているすべてのトピックの中で、一意でなければなりません。 .chm ヘルプ ファイルの場合、Topic は、そのトピックを含むソース .htm ファイルの名前になります。
ヘルプ システムは、トピック ベースのヘルプ要求を受け取ると、登録を受けた各ヘルプ ビューアに対して UnderstandsTopic への呼び出しを、そのメソッドが True を返すまで続けます。ヘルプ ビューアは、System.HelpIntfs.RegisterViewer に対して登録された順番で、ポーリングされます。ヘルプ システムは、その後、ヘルプ ビューアの DisplayTopic メソッドを呼び出します。
UnderstandsTopic を使用するには、アプリケーションの uses 句に、Vcl.HtmlHelpViewer ユニットまたは他のユニットを挿入します。これらは、使用する外部ヘルプ ビューアへのインターフェイスを提供してくれます。 C++ の場合には、HTMLHelpViewer.hpp ヘッダー ファイルをインクルードする必要があります。