RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
IHelpSystem3.ShowIndex Method
IHelpSystem3 Interface | IHelpSystem3 Members | HelpIntfs Namespace | Description | See Also
Collapse All

Opens Index pane of Help Viewer.

Pascal
procedure ShowIndex(const Topic: string; const HelpFileName: string);
C++
__fastcall ShowIndex(const AnsiString Topic, const AnsiString HelpFileName);
Description

The RTL Help System calls ShowIndex to have a Viewer open its Index Pane. If the Help Viewer has the ability to search for the given topic parameter, it executes the Index search; otherwise it is ignored. The HelpFileName parameter is only used in certain help systems (such as Microsoft HTML Help) and is used only if there is no help file name already known by the Help System. 

The help system queries all registered Help Viewers. If only one viewer can display an Index pane, it is shown; otherwise the user is asked to decide which Viewer to display. 

 

See Also
Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!