Vcl.Forms.TApplication.HelpContext
Delphi
function HelpContext(Context: THelpContext): Boolean;
C++
bool __fastcall HelpContext(System::Classes::THelpContext Context);
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 l'identificateur de contexte numérique.
Utilisez HelpContext pour afficher la rubrique d'aide spécifiée par l'identificateur de contexte numérique Context à partir du fichier spécifié dans la propriété CurrentHelpFile. HelpContext génère un événement OnHelp soit sur la fiche active, soit sur l'objet application lui-même. S'il n'existe pas de gestionnaire d'événements OnHelp ou si le gestionnaire d'événements indique que HTMLHelp doit être appelé, HelpContext appelle alors le moteur d'aide Windows HTMLHelp, en lui transmettant l'identificateur de contexte spécifié dans le paramètre Context.
Par exemple, si Context a la valeur 714, la méthode HelpContext affiche la rubrique d'aide avec l'identificateur de contexte 714 du fichier d'aide spécifié par CurrentHelpFile. Pour un fichier d'aide .chm, vous devez mapper symboliquement les identificateurs de contexte des rubriques d'aide aux valeurs numériques du Context dans la section [MAP] de votre fichier projet (.hhp).
HelpContext renvoie False si CurrentHelpFile contient une chaîne vide, ce qui signifie que l'application n'a pas de fichier d'aide affecté. Dans tous les autres cas, HelpContext renvoie True.
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.