System.HelpIntfs.IHelpSystem.ShowContextHelp

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

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

C++

virtual void __fastcall ShowContextHelp(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 IHelpSystem

Description

Displays the Help topic specified by the numeric context identifier ContextID.

Call ShowContextHelp to display a Help topic, which is identified by the numeric context identifier ContextID and which is in the specified Help file HelpFileName.

In case of a .chm Help file, you must map symbolic Context IDs of Help topics to numeric ContextID values in the [MAP] section of your project (.hhp) file.

For context-based Help requests to work, the application must have previously registered at least one Help Viewer that implements IExtendedHelpViewer. If no such Viewer is found, an EHelpSystemException is raised.

In order to use ShowContextHelp, 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.