Vcl.Forms.THelpEvent
Delphi
THelpEvent = function(Command: Word; Data: THelpEventData; var CallHelp: Boolean): Boolean of object;
C++
typedef bool __fastcall (__closure *THelpEvent)(System::Word Command, NativeInt Data, bool &CallHelp);
Eigenschaften
| Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
|---|---|---|---|---|
type typedef |
public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | Vcl.Forms |
Beschreibung
THelpEvent ist der Typ einer Ereignisbehandlungsroutine für OnHelp.
THelpEvent enthält die folgenden Parameter:
Command, der die Art des aufgerufenen Hilfebefehls angibt. Die Bedeutung ist vom aktuellen Hilfesystem abhängig. Bei HTMLHelp istCommandbeispielsweise der von der HTMLHelp-API verwendete Befehl. Genaue Informationen zu den möglichen Befehlen finden Sie im jeweiligen HTMLHelp-Thema in der MSDN-Bibliothek.
Data, der zusätzliche Informationen enthält, um die gewünschte Aktion des Hilfesystems zu beschreiben. Der Wert dieses Parameters ist vom Wert der EigenschaftCommandabhängig. Normalerweise gibtDataeine Schlüsselwort oder eine Kontext-ID an. Genaue Informationen finden Sie im jeweiligen HTMLHelp-Thema in der MSDN-Bibliothek.
CallHelpwird in der Ereignisbehandlungsroutine zugewiesen. WennCallHelpbeim Beenden der Routinetrueist, wird der Hilfebefehl an das Hilfesystem übergeben. Wenn die Ereignisbehandlungsroutine den Befehl behandelt, wirdCallHelpauffalsegesetzt, damit der Hilfebefehl nicht an das Hilfesystem übergeben wird.
Um die Ereignisbehandlungsroutine für OnHelp richtig 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.
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.