System.HelpIntfs.IHelpSystem.ShowContextHelp

• Übergeordnet: IHelpSystem

Delphi

procedure ShowContextHelp(const ContextID: THelpContext; const HelpFileName: string);

C++

virtual void __fastcall ShowContextHelp(const System::Classes::THelpContext ContextID, const System::UnicodeString HelpFileName) = 0 ;

Eigenschaften

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

Beschreibung

Zeigt das durch den in ContextID angegebenen numerischen Kontextbezeichner gegebenen Hilfethema an.

Rufen Sie ShowContextHelp zum Anzeigen eines Hilfethemas auf, das durch den in ContextID angegebenen numerischen Kontextbezeichner identifiziert wird und sich in der angegebenen Hilfedatei HelpFileName befindet.

Für eine .chm-Hilfedatei müssen Sie symbolische Kontext-IDs der Hilfethemen zu den numerischen ContextID-Werten im [MAP]-Abschnitt Ihrer Projektdatei (.hhp) zuordnen.

Damit kontextbasierte Hilfeanforderungen funktionieren, muss die Anwendung zuvor mindestens einen Hilfe-Viewer registriert haben, der IExtendedHelpViewer implementiert. Wird kein solcher Viewer gefunden, wird eine EHelpSystemException ausgelöst.

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