Vcl.Forms.TForm.OnHelp
Delphi
property OnHelp;
C++
__property OnHelp;
Eigenschaften
Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
---|---|---|---|---|
event | published | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | TForm |
Beschreibung
Wird ausgelöst, wenn das Formular eine Hilfe-Anforderung erhält.
Vcl.Forms.TForm.OnHelp erbt von Vcl.Forms.TCustomForm.OnHelp. Der folgende Inhalt bezieht sich auf Vcl.Forms.TCustomForm.OnHelp.
Wird ausgelöst, wenn das Formular eine Hilfe-Anforderung erhält.
Mit einer Ereignisbehandlungsroutine für OnHelp können Sie spezielle Aktion ausführen, wenn der Benutzer Hilfe anfordert. Die Methoden HelpContext und HelpJump lösen das Ereignis OnHelp automatisch aus.
Der Typ THelpEvent enthält die folgenden Parameter: CallHelp
, Command
und Data
.
Setzen Sie CallHelp
auf true
, wenn die Anwendung das Hilfesystem nach dem Ereignis starten soll. Setzen Sie CallHelp
auf false
, um den vom Hilfesystem angegebenen Standardantwort zu unterdrücken. Alle Hilfe-Methoden der Anwendung werden mit Hilfe von OnHelp ausgeführt. Die Anwendung ruft das Hilfesystem nur auf, wenn der Parameter CallHelp
der Ereignisbehandlungsroutine für OnHelp true
ist oder wenn keine Ereignisbehandlungsroutine für OnHelp definiert wurde.
Bei Erfolg gibt die Ereignisbehandlungsroutine True zurück, andernfalls False.
Die möglichen Werte für den Parameter Data
sind vom Wert des Parameters Command
abhängig. Die möglichen Werte für die Parameter Command
und Data
finden Sie im jeweiligen HTMLHelp-Thema in der MSDN-Bibliothek.
Um die Ereignisbehandlungsroutine für OnHelp korrekt zu funktionieren, 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. Die Unit Vcl.HtmlHelpViewer stellt ein Delphi-Interface für die native Windows-Hilfebehandlungsfunktion HTMLHelp bereit. Bei C++ müssen Sie die Header-Datei HTMLHelpViewer.hpp einbeziehen.