System.HelpIntfs.ICustomHelpViewer.CanShowTableOfContents

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function  CanShowTableOfContents : Boolean;

C++

virtual bool __fastcall CanShowTableOfContents() = 0 ;

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs ICustomHelpViewer

Beschreibung

Unterstützt die Abfrage des Inhaltsverzeichnisses.

Das Hilfesystem verwendet CanShowTableOfContents, um zu ermitteln, welche Hilfe-Viewer ein Inhaltsverzeichnis anzeigen können. CanShowTableOfContents gibt True zurück, wenn der Viewer für einen nachfolgenden Aufruf von ShowTableOfContents bereit ist. Das Hilfesystem darf ShowTableOfContents nicht für einen Viewer aufrufen, nachdem CanShowTableOfContents den Wert False zurückgegeben hat. Wenn dies vorkommt, löst der Viewer eine EHelpSystemException aus.

Für die Verwendung von CanShowTableOfContents 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. Bei C++ müssen Sie die Header-Datei HTMLHelpViewer.hpp einbeziehen.

Siehe auch