Vcl.Forms.TApplication.HelpKeyword
Delphi
function HelpKeyword(const Keyword: string): Boolean;
C++
bool __fastcall HelpKeyword(const System::UnicodeString Keyword);
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | TApplication |
Description
Displays the Help topic specified by the keyword.
Use HelpKeyword to show the Help topic, which has the Keyword parameter and which is from the file specified in the CurrentHelpFile property. HelpKeyword invokes the current Help system, passing it the string specified by Keyword. If the current Help system is HTMLHelp (or WinHelp), this displays the Help topic having an Alink tag equal to Keyword.
HelpKeyword returns False if the current Help system does not support keyword lookups.
In order for the Help to work properly, insert in the uses clause of your application the Vcl.HtmlHelpViewer or another unit that provides an interface to the external Help viewer to use. The Vcl.HtmlHelpViewer unit provides a Delphi interface to the HTMLHelp Windows native Help handling function. For C++, you need to include the HTMLHelpViewer.hpp header files.
For information about the native Help handling functions (HTMLHelp or other) and about the data passed to them, see the appropriate HTMLHelp topics in the MSDN Library.