Vcl.Forms.TApplication.HelpContext

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function HelpContext(Context: THelpContext): Boolean;

C++

bool __fastcall HelpContext(System::Classes::THelpContext Context);

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
Vcl.Forms.pas
Vcl.Forms.hpp
Vcl.Forms TApplication

Beschreibung

Zeigt das durch den numerischen Kontext-Bezeichner angegebene Hilfethema an.

Mit HelpContext können Sie das durch den in Context angegebene numerische Kontext-Bezeichner festgelegte Hilfethema aus der in der Eigenschaft CurrentHelpFile angegebenen Datei anzeigen. HelpContext erzeugt ein Ereignis OnHelp (entweder für das aktive Formular oder für das Anwendungsobjekt selbst). Wenn keine Ereignisbehandlungsroutine für OnHelp vorhanden ist oder wenn diese den Aufruf von HTMLHelp erfordert, ruft HelpContext die HTMLHelp-Hilfe-Engine von Windows auf, wobei die im Parameter Context angegebene Hilfekontext-ID übergeben wird.

Wenn beispielsweise der Wert von Context 714 ist, ruft die Methode HelpContext die Anzeige mit der Hilfekontext-ID 714 in der über CurrentHelpFile angegebenen Hilfedatei auf. Für eine .chm-Hilfedatei müssen Sie symbolische Kontext-IDs der Hilfethemen den in Context angegebenen numerischen Werten im [MAP]-Abschnitt Ihrer Projektdatei (.hhp) zuordnen.

HelpContext gibt False zurück, wenn CurrentHelpFile einen leeren String repräsentiert. D.h., dass der Anwendung keine Hilfedatei zugewiesen ist. In allen anderen Fällen gibt HelpContext den Wert True zurück.

Um die Hilfe richtig zu funktionieren, fügen Sie der uses-Klausel Ihrer Anwendung Vcl.HtmlHelpViewer oder eine andere Unit hinzu, die ein Interface für den zu verwendenden, externen Hilfe-Viewer bereitstellt. Die Unit Vcl.HtmlHelpViewer stellt ein Delphi-Interface für die native Windows-Hilfebehandlungsfunktion HTMLHelp bereit. Für C++ müssen Sie die Header-Dateien HTMLHelpViewer.hpp einbeziehen.

Informationen über die nativen Funktionen zur Hilfebehandlung (HTMLHelp oder andere) und zu den übergebenen Daten finden Sie im jeweiligen HTMLHelp-Thema in der MSDN-Bibliothek.

Siehe auch