System.HelpIntfs.IExtendedHelpViewer.UnderstandsContext

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

Delphi

function UnderstandsContext(const ContextID: THelpContext;
const HelpFileName: string): Boolean;

C++

virtual bool __fastcall UnderstandsContext(const System::Classes::THelpContext ContextID, const System::UnicodeString HelpFileName) = 0 ;

プロパティ

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


説明

ヘルプ ビューアに、指定された数値の ContextID が解釈可能か、問い合わせます。

UnderstandsContext は、ヘルプ ビューアが、指定された HelpFileName ヘルプ ファイルにおいて、数値のコンテキスト識別子 ContextID で識別されるトピックを表示できる場合には、True を返す必要があります。

ヘルプ システムは、コンテキスト ID ベースのヘルプ要求を受け取ると、登録を受けた各ヘルプ ビューアに対して UnderstandsContext への呼び出しを、そのメソッドが True を返すまで続けます。 ヘルプ ビューアは、System.HelpIntfs.RegisterViewer に対して登録された順番で、ポーリングされます。 ヘルプ システムは、その後、ヘルプ ビューアの DisplayHelpByContext メソッドを呼び出します。

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

関連項目