Vcl.Forms.TApplication.HelpKeyword
Delphi
function HelpKeyword(const Keyword: string): Boolean;
C++
bool __fastcall HelpKeyword(const System::UnicodeString Keyword);
Eigenschaften
Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
---|---|---|---|---|
function | public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | TApplication |
Beschreibung
Zeigt das durch das Schlüsselwort festgelegte Hilfethema an.
Mit HelpKeyword können Sie das über den Parameter Keyword
angegebene Hilfethema aus der in der Eigenschaft CurrentHelpFile angegebenen Datei anzeigen. HelpKeyword ruft das aktuelle Hilfesystem auf und übergibt dabei den in Keyword
angegebenen String. Wenn es sich bei dem aktuellen System um HTMLHelp (oder WinHelp) handelt, wird das Hilfethema angezeigt, das ein in Alink
angegebenes Tag gleich mit dem in Keyword
angegebenen Schlüsselwort enthält.
HelpKeyword gibt False zurück, wenn das aktuelle Hilfesystem die Schlüsselwort-basierten Nachschlagevorgänge nicht unterstützt.
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.