Vue d'ensemble du composant HelpProvider (Windows Forms)

  • Article

Mise à jour : novembre 2007

Le composant HelpProvider Windows Forms permet d'associer un fichier d'aide HTML Help 1.x (fichier .chm généré par HTML Help Workshop ou fichier .htm) à votre application Windows. Vous pouvez fournir de l'aide via différentes méthodes :

  • par l'affichage d'une aide contextuelle pour les contrôles des Windows Forms ;

  • par l'affichage d'une aide contextuelle sur une boîte de dialogue spécifique ou sur certains contrôles d'une boîte de dialogue ;

  • par l'ouverture d'un fichier d'aide dans des zones spécifiques (page principale d'un sommaire, index ou fonction de recherche, par exemple).

Utilisation du composant HelpProvider

L'ajout d'un composant HelpProvider à votre Windows Form permet aux autres contrôles du formulaire d'exposer les propriétés d'aide du composant HelpProvider. Cela permet de fournir de l'aide pour les contrôles de votre Windows Form. Vous pouvez associer un fichier d'aide au composant HelpProvider au moyen de la propriété HelpNamespace. Vous spécifiez le type d'aide fourni en appelant la méthode SetHelpNavigator et en fournissant une valeur de l'énumération HelpNavigator pour le contrôle spécifié. Vous fournissez le mot clé ou le sujet de l'aide en appelant la méthode SetHelpKeyword.

Vous pouvez également associer une chaîne d'aide spécifique à un autre contrôle au moyen de la méthode SetHelpString. La chaîne que vous associez à un contrôle en vous servant de cette méthode vient s'afficher dans une fenêtre indépendante quand l'utilisateur appuie sur la touche F1 alors que le contrôle a le focus.

Si HelpNamespace n'a pas été défini, vous devez utiliser SetHelpString pour fournir le texte d'aide. Si vous avez défini HelpNamespace et la chaîne d'aide, l'aide de HelpNamespace prévaut.

Remarque :

Des incidents risquent de survenir lorsque vous utilisez le chemin d'accès relatif pour spécifier le chemin d'accès au fichier d'aide dans la méthode ShowHelp ou dans la propriété HelpNamespace du contrôle HelpProvider. C'est la raison pour laquelle vous devez veiller à utiliser le chemin d'accès absolu du fichier d'aide.

Voir aussi

Concepts

Systèmes d'aide dans les applications Windows Forms