System.HelpIntfs.IExtendedHelpViewer.DisplayHelpByContext

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

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

C++

virtual void __fastcall DisplayHelpByContext(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 IExtendedHelpViewer

Beschreibung

Zeigt das durch den numerischen Kontextbezeichner angegebene Hilfethema an.

Das Hilfesystem ruft DisplayHelpByContext auf, damit eine kontextbasierte Hilfeanforderung verarbeitet werden kann:

  • ContextID bezeichnet die numerische Kontext-ID des Hilfethemas. Für eine .chm-Hilfedatei müssen Sie symbolische Kontext-IDs der Hilfethemen zu den numerischen IDs im [MAP]-Abschnitt Ihrer Projektdatei (.hhp) zuordnen.
  • HelpFileName ist der Name der Datei, die das Thema enthält. In einigen Hilfe-Engines muss der Dateiname als vollständig qualifizierter Pfad angegeben werden.

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