System.HelpIntfs.IHelpSystem3.ShowIndex
Delphi
procedure ShowIndex(const Topic, HelpFileName: string);
C++
virtual void __fastcall ShowIndex(const System::UnicodeString Topic, const System::UnicodeString HelpFileName) = 0 ;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
procedure function |
public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | IHelpSystem3 |
Description
Opens Index pane of Help Viewer.
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.