System.HelpIntfs.IExtendedHelpViewer.DisplayTopic

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure DisplayTopic(const Topic: string);

C++

virtual void __fastcall DisplayTopic(const System::UnicodeString Topic) = 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 string value.

The Help System calls DisplayTopic to handle a keyword-based Help request.

Topic is the string that identifies the help topic. This string must be unique for all the topics maintained by a particular Help Viewer.

In case of .chm format Help files, Topic should be the name of the source .htm file containing the topic to show.

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