System.HelpIntfs.IExtendedHelpViewer.DisplayHelpByContext

• Up to Parent: IExtendedHelpViewer

Delphi

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

C++

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

Properties

Type	Visibility	Source	Unit	Parent
procedure function	public	System.HelpIntfs.pas System.HelpIntfs.hpp	System.HelpIntfs	IExtendedHelpViewer

Description

Displays the Help topic specified by the numeric context identifier.

The Help System calls DisplayHelpByContext to handle a context-based Help request:

• ContextID is the Help topic's numeric context ID. In case of a .chm help file, you must map symbolic context IDs of Help topics to numeric IDs in the [MAP] section of your project (.hhp) file.
• HelpFileName is the name of the file containing the topic. Note that some Help engines require the file name to be fully qualified.

In order to use DisplayHelpByContext, insert in the uses clause of your application the Vcl.HtmlHelpViewer or another unit that provides an interface to the external Help viewer to use. For C++, you need to include the HTMLHelpViewer.hpp header file.

See Also

• System.HelpIntfs.IExtendedHelpViewer.UnderstandsTopic