Vcl.Forms.TApplication.HelpShowTableOfContents

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function HelpShowTableOfContents: Boolean;

C++

bool __fastcall HelpShowTableOfContents();

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
Vcl.Forms.pas
Vcl.Forms.hpp
Vcl.Forms TApplication

Beschreibung

Zeigt das Inhaltsverzeichnis des Hilfesystems an.

Mit HelpShowTableOfContents wird das in der Eigenschaft CurrentHelpFile angegebene Inhaltsverzeichnis des Hilfesystems aufgerufen. Diese Methode ist dem Aufruf von System.HelpIntfs.ICustomHelpViewer.ShowTableOfContents vorzuziehen, die nicht als erster Aufruf im Hilfesystem verwendet werden kann.

Um HelpShowTableOfContents zu funktionieren und die korrekte native Hilfebehandlungsfunktion aufzurufen, fügen Sie der uses-Klausel Ihrer Anwendung die Unit Vcl.HtmlHelpViewer oder eine andere Unit hinzu, die ein Interface für den externen, zu verwendenden Hilfe-Viewer bereitstellt. Die Unit Vcl.HtmlHelpViewer stellt ein Delphi-Interface für die native Windows-Hilfebehandlungsfunktion HTMLHelp bereit. Bei C++ müssen Sie die Header-Dateien HTMLHelpViewer.hpp einbeziehen.

Informationen über die nativen Funktionen zur Hilfebehandlung (HTMLHelp oder andere) und zu den übergebenen Daten finden Sie im jeweiligen HTMLHelp-Thema in der MSDN-Bibliothek.

Siehe auch