Vcl.Forms.TApplication.HelpKeyword
Delphi
function HelpKeyword(const Keyword: string): Boolean;
C++
bool __fastcall HelpKeyword(const System::UnicodeString Keyword);
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| function | public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | TApplication |
Description
Affiche la rubrique d'aide spécifiée par le mot clé.
Utilisez HelpKeyword pour afficher la rubrique d'aide contenant le paramètre Keyword et se trouvant dans le fichier spécifié dans la propriété CurrentHelpFile. HelpKeyword invoque le système d'aide en cours, en lui transmettant la chaîne spécifiée par Keyword. Si le système d'aide en cours est HTMLHelp (ou WinHelp), elle affiche la rubrique d'aide dont la balise Alink est égale à Keyword.
HelpKeyword renvoie False si le système d'aide en cours ne gère pas les recherches par mot clé.
Pour que l'aide fonctionne correctement, insérez dans la clause uses de votre application le Vcl.HtmlHelpViewer ou une autre unité fournissant une interface utilisée par la visionneuse d’aide externe. L'unité Vcl.HtmlHelpViewer fournit une interface Delphi à la fonction de gestion d'aide native Windows HTMLHelp. Pour C++, vous devez inclure les fichiers d'en-tête HTMLHelpViewer.hpp.
Pour obtenir des informations sur les fonctions de gestion d'aide natives (HTMLHelp ou autre) et sur les données qui leur sont transmises, voir les rubriques HTMLHelp appropriées dans la bibliothèque MSDN.