System.HelpIntfs.IHelpSystem.ShowContextHelp

提供:RAD Studio API Documentation

Delphi

procedure ShowContextHelp(const ContextID: THelpContext; const HelpFileName: string);

C++

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

プロパティ

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


説明

数値のコンテキスト識別子 ContextID で指定されたヘルプ トピックを表示します。

ShowContextHelp を呼び出すと、指定されたヘルプ ファイル HelpFileName において、数値のコンテキスト識別子 ContextID で識別される、ヘルプ トピックを表示することができます。

.chm ヘルプ ファイルの場合、ヘルプ トピックのシンボリック Context ID を、プロジェクト ファイル(.hhp)の [MAP] セクションにある、数値の ContextID 値にマップしなければなりません。

コンテキスト ベースのヘルプ要求を機能させるには、アプリケーションで、最低でも 1 つ、IExtendedHelpViewer を実装するヘルプ ビューアを登録しておかなければなりません。そのようなビューアが見つからない場合、EHelpSystemException が発生します。

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