Vcl.AppEvnts.TCustomApplicationEvents.OnHelp
Delphi
property OnHelp: THelpEvent read FOnHelp write FOnHelp;
C++
__property Vcl::Forms::THelpEvent OnHelp = {read=FOnHelp, write=FOnHelp};
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| event | protected | Vcl.AppEvnts.pas Vcl.AppEvnts.hpp |
Vcl.AppEvnts | TCustomApplicationEvents |
Description
Se produit quand l'application reçoit une demande d'aide.
Ecrivez un gestionnaire d'événements OnHelp pour effectuer des actions particulières quand l'aide est appelée. Les méthodes HelpContext et HelpJump déclenchent automatiquement l'événement OnHelp.
Le type THelpEvent comprend les paramètres suivants : CallHelp, Command et Data.
Affectez la valeur true à CallHelp si l'application doit toujours appeler le système d'aide après l'événement. Affectez-lui la valeur false pour empêcher la réponse par défaut du système d'aide. Toutes les méthodes d'aide de l'application passent par OnHelp. L'application n'appelle le système d'aide que si le paramètre CallHelp de OnHelp renvoie true ou si le gestionnaire d'événements OnHelp n'est pas affecté.
Le gestionnaire d'événements renvoie True en cas de succès, False en cas d'échec.
Les valeurs possibles du paramètre Data dépendent de la valeur du paramètre Command. Pour trouver les valeurs possibles des paramètres Command et Data, consultez les rubriques HTMLHelp appropriées dans la bibliothèque MSDN.
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.
Remarque : Appelez la méthode CancelDispatch à partir d'un gestionnaire d'événements OnHelp pour éviter que l'application n'envoie l'événement à n'importe quel autre objet événements d'application.
Voir aussi
- Vcl.Forms.TApplication.HelpCommand
- Vcl.Forms.TApplication.HelpContext
- Vcl.Forms.TApplication.HelpFile
- Vcl.AppEvnts.TCustomApplicationEvents.CancelDispatch
- Vcl.Forms.TApplication.HelpJump