Vcl.Forms.THelpEvent

De RAD Studio API Documentation
Aller à : navigation, rechercher

C++

typedef bool __fastcall (__closure *THelpEvent)(System::Word Command, NativeInt Data, bool &CallHelp);

Propriétés

Type Visibilité  Source Unité  Parent
typedef public Vcl.Forms.hpp Vcl.Forms Vcl.Forms


Description

THelpEvent est le type d'un gestionnaire d'événements OnHelp.

THelpEvent comprend les paramètres suivants :

  • Command, indique le type de commande d'aide émise. Sa signification dépend du système d'aide en cours. Par exemple, si vous utilisez HTMLHelp, Command représente la commande utilisée par l'API HTMLHelp. Pour plus d'informations sur les commandes possibles, voir les rubriques HTMLHelp appropriées dans la bibliothèque MSDN.
  • Data fournit des données supplémentaires pour décrire l'action souhaitée par le système d'aide. Sa valeur dépend de la valeur de la propriété Command. Typiquement, Data spécifie un mot clé ou un identificateur de contexte. Pour plus de détails, voir les rubriques HTMLHelp appropriées dans la bibliothèque MSDN.
  • CallHelp est défini par le gestionnaire d'événements. Si CallHelp a la valeur true à la sortie du gestionnaire d'événements, l'application doit transmettre la commande d'aide au système d'aide. Si le gestionnaire d'événements traite la commande, il attribue la valeur false à CallHelp pour que l'application ne transmette pas la commande d'aide au système d'aide.

Pour que le gestionnaire d'événements OnHelp 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 le fichier 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.

Voir aussi