Vcl.Forms.TApplication.HelpFile
Delphi
property HelpFile: string read FHelpFile write FHelpFile;
C++
__property System::UnicodeString HelpFile = {read=FHelpFile, write=FHelpFile};
Inhaltsverzeichnis
Eigenschaften
| Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
|---|---|---|---|---|
| property | public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | TApplication |
Beschreibung
Legt den Namen der Standardhilfedatei fest, die von der Anwendung zum Anzeigen der Hilfe verwendet wird.
Verwenden Sie die Eigenschaft HelpFile zum Festlegen einer Standardhilfedatei für Anwendungen, die das VCL-Hilfesystem nutzen.
Sie können entweder zur Laufzeit der Eigenschaft HelpFile einen Hiledateinamen zuweisen oder zur Entwurfszeit eine Hilfedatei in der Option Hilfedatei der Seite Anwendungsoptionen des Dialogfeldes Projektoptionen angeben.
Das in der Eigenschaft TApplication.HelpSystem angegebene Hilfesystem zeigt die Hilfethemen der von der Eigenschaft CurrentHelpFile angegebenen Datei an. HelpFile stellt den Wert von CurrentHelpFile bereit, sofern eine in TForm.HelpFile angegebene Hilfedatei dem aktiven Formular nicht zugeordnet ist.
Standardmäßig ist HelpFile einen Nullstring und die Methode Help der Anwendung ignoriert die Versuche zum Anzeigen der Hilfeinformationen, sofern dem aktiven Formular keine Hilfedatei zugeordnet ist.
Um die Hilfe zu funktionieren und die korrekte native Hilfebehandlungsfunktion aufzurufen, fügen Sie der uses-Klausel Ihrer Anwendung die entsprechenden Vcl.HtmlHelpViewer, Vcl.WinHelpViewer oder eine andere Unit hinzu. Die Unit Vcl.HtmlHelpViewer stellt ein Delphi-Interface für die native Windows-Hilfebehandlungsfunktion HTMLHelp bereit. Für C++ müssen Sie die Header-Datei HTMLHelpViewer.hpp bzw. WinHelpViewer.hpp einbeziehen.