System.HelpIntfs.IExtendedHelpViewer.UnderstandsTopic

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function UnderstandsTopic(const Topic: string): Boolean;

C++

virtual bool __fastcall UnderstandsTopic(const System::UnicodeString Topic) = 0 ;

Eigenschaften

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

Beschreibung

Überprüft, ob der Hilfe-Viewer den in Topic angegebenen String identifizieren kann.

UnderstandsTopic gibt True zurück, wenn der Hilfe-Viewer die Themen mit den im Parameter Topic angegebenen Themennamen identifizieren kann.

Topic muss für alle von einem bestimmten Hilfe-Viewer verwalteten Themen eindeutig sein. Für eine .chm-Hilfedatei sollte Topic den Namen der .htm-Quelltextdatei angeben, die das Thema enthält.

Wenn das Hilfesystem eine themenbasierte Hilfeanforderung empfängt, ruft es für jeden Hilfe-Viewer UnderstandsTopic auf, bis die Methode True zurückgibt. Hilfe-Viewer werden in der Reihenfolge ihrer Registrierung bei System.HelpIntfs.RegisterViewer abgefragt. Anschließend ruft das Hilfesystem die Methode DisplayTopic des Hilfe-Viewers auf.

Für die Verwendung von UnderstandsTopic 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