System.HelpIntfs.IExtendedHelpViewer.UnderstandsContext

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function UnderstandsContext(const ContextID: THelpContext;
const HelpFileName: string): Boolean;

C++

virtual bool __fastcall UnderstandsContext(const System::Classes::THelpContext ContextID, const System::UnicodeString HelpFileName) = 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 die in ContextID angegebene numerische Kontext-ID identifizieren kann.

UnderstandsContext gibt True zurück, wenn der Hilfe-Viewer das durch den in ContextID angegebenen numerischen Kontextbezeichner identifizierte Thema in der in HelpFileName angegebenen Hilfedatei anzeigen kann.

Wenn das Hilfesystem eine auf der Kontext-ID basierende Hilfeanforderung empfängt, ruft es für jeden registrierten Hilfe-Viewer UnderstandsContext 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 DisplayHelpByContext des Hilfe-Viewers auf.

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