Partager via

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

  • Article

Vous pouvez utiliser le composant HelpProvider 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 supérieur.

Fournir de l’aide

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

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

  2. Dans la fenêtre Propriétés, définissez la propriété HelpNamespace 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 propriété .

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

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

    Cela détermine la façon dont la propriété HelpKeyword est transmise au système d’aide. Le tableau suivant présente les paramètres possibles et leurs descriptions.

    Nom du membre Description
    AssociateIndex Spécifie que l’index d’une rubrique spécifiée est effectué dans l’URL spécifiée.
    Trouver Spécifie que la page de recherche d’une URL spécifiée s’affiche.
    Index Spécifie que l’index d’une URL spécifiée est affiché.
    Index des mots-clés Spécifie un mot clé à rechercher et l’action à entreprendre dans l’URL spécifiée.
    Table des matières Spécifie que la table des matières du fichier d’aide HTML 1.0 s’affiche.
    Sujet Spécifie que la rubrique référencée par l’URL spécifiée s’affiche.

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

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 adresse de http://, telle qu’une page web. Si cela est fait, cela ouvrira le navigateur par défaut sur la page Web avec la chaîne spécifiée dans la propriété HelpKeyword servant d'ancre. L’ancre est utilisée pour accéder à une partie spécifique d’une page HTML.

Important

Veillez à vérifier les informations envoyées à partir d’un client avant de l’utiliser dans votre application. Les utilisateurs malveillants peuvent essayer d’envoyer ou d’injecter un script exécutable, des instructions SQL ou d’autres codes. Avant d’afficher l’entrée d’un utilisateur, stockez-la dans une base de données ou utilisez-la, vérifiez qu’elle ne contient pas d’informations potentiellement dangereuses. Une façon classique de vérifier consiste à utiliser une expression régulière pour rechercher des mots clés tels que « SCRIPT » lorsque vous recevez une entrée d’un utilisateur.

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

Voir aussi