Partager via

Guide pratique pour fournir de l'aide dans une application Windows

  • Article

Vous pouvez utiliser le HelpProvider composant pour joindre des rubriques d’aide dans un fichier d’aide à des contrôles spécifiques sur Windows Forms. Le fichier d’aide peut être au format HTML, ou HTMLHelp 1.x ou ultérieur.

Fournir de l’aide

  1. Dans Visual Studio, à partir de la boîte à outils, faites glisser un HelpProvider composant vers votre formulaire.

    Le composant sera placé dans la barre d’état en bas du Concepteur Windows Forms.

  2. Dans la fenêtre Propriétés , définissez la HelpNamespace propriété sur le fichier d’aide .chm, .col ou .htm.

  3. Sélectionnez un autre contrôle que vous avez sur votre formulaire, puis, dans la fenêtre Propriétés , définissez la SetHelpKeyword propriété.

    Il s’agit de la chaîne transmise par le HelpProvider composant à votre fichier d’aide pour appeler la rubrique d’aide appropriée.

  4. Dans la fenêtre Propriétés , définissez la SetHelpNavigator propriété sur une valeur de l’énumération HelpNavigator .

    Ceci détermine la façon dont la propriété HelpKeyword est passée au système d’aide. Le tableau suivant montre les paramètres possibles et leur description.

    Member Name Description
    AssociateIndex Spécifie que l’index d’une rubrique spécifiée est exécuté dans l’URL spécifiée.
    Rechercher Spécifie que la page de recherche d’une URL spécifiée est affichée.
    Index Spécifie que l’index d’une URL spécifiée est affiché.
    KeywordIndex Spécifie un mot clé à rechercher et l’action à effectuer dans l’URL spécifiée.
    TableOfContents Spécifie que la table des matières du fichier d’aide HTML 1.0 est affiché.
    Rubrique Spécifie que la rubrique référencée par l’URL spécifiée est affichée.

Au moment de l’exécution, appuyez sur F1 lorsque le contrôle( pour lequel vous avez défini les propriétés HelpKeyword et HelpNavigator ) ouvre le fichier d’aide que vous avez associé à ce HelpProvider composant.

Actuellement, la propriété HelpNamespace prend en charge les fichiers d’aide dans les trois formats suivants : HTMLHelp 1.x, HTMLHelp 2.0 et HTML. Par conséquent, vous pouvez définir la propriété HelpNamespace sur une http:// adresse, telle qu’une page Web. Dans ce cas, elle ouvre le navigateur par défaut à la page web avec la chaîne spécifiée dans la propriété HelpKeyword utilisée comme ancre. L’ancre est utilisée pour accéder à une partie spécifique d’une page HTML.

Important

Prenez soin de vérifier toutes les informations envoyées par un client avant de les utiliser dans votre application. Des utilisateurs malveillants peuvent tenter d’envoyer ou d’injecter un script exécutable, des instructions SQL ou un autre code. Avant d’afficher une entrée utilisateur, de la stocker dans une base de données ou de l’utiliser, vérifiez qu’elle ne contient pas d’informations potentiellement dangereuses. Une façon habituelle de le vérifier est d’utiliser une expression régulière pour rechercher des mots clés comme « SCRIPT » quand vous recevez une entrée d’un utilisateur.

Vous pouvez également utiliser le composant pour afficher l’aide HelpProvider contextuelle, même si vous avez configuré pour afficher les fichiers d’aide pour les contrôles de votre Windows Forms. Pour plus d’informations, consultez Guide pratique pour afficher l’aide contextuelle.

Voir aussi