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 ;
Eigenschaften
| Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
|---|---|---|---|---|
procedure function |
public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | IHelpSystem3 |
Beschreibung
Öffnet das Index-Fenster des Hilfe-Viewers.
Das RTL-Hilfesystem ruft ShowIndex auf, um ein Viewer seines Index-Fenster zu öffnen. Wenn der Hilfe-Viewer nach dem angegebenen Themenparameter suchen kann, führt er die Index-Suche aus; ansonsten wird diese ignoriert. Der HelpFileName-Parameter wird nur in bestimmten Hilfesystemen (wie z.B Microsoft HTML-Hilfe) verwendet und nur wenn kein von dem Hilfesystem bekannter Hilfedateiname vorhanden ist.
Die Hilfesystem fragt alle registrierten Hilfe-Viewers ab. Wenn nur ein Viewer ein Index-Fenster anzeigen kann, dann wird es angezeigt; ansonsten muss der Benutzer entscheiden, welcher Viewer angezeigt werden soll.