Vcl.Forms.TApplication.HelpJump

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function HelpJump(const JumpID: string): Boolean;

C++

bool __fastcall HelpJump(const System::UnicodeString JumpID);

Eigenschaften

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

Beschreibung

Zeigt das durch den symbolischen Namen angegebene Hilfethema an.

Mit HelpJump können Sie das über den symbolischen Namen JumpID identifizierte Thema aus der in der Eigenschaft CurrentHelpFile angegebenen Hilfedatei anzeigen.

HelpJump 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 der nativen Hilfebehandlungsfunktion erfordert, ruft HelpJump die native Hilfebehandlungsfunktion HTMLHelp (oder WinHelp) auf, wobei der symbolische Name JumpID übergeben wird. Für eine .chm-Hilfedatei sollte JumpID der Name der .htm-Quelltextdatei sein, die das Thema enthält.

HelpJump gibt den Wert 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 HelpJump den Wert True zurück.

Um HelpJump zu funktionieren und die entsprechende native Hilfebehandlungsfunktion aufzurufen, 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