Assistance utilisateur pour les composants
Mise à jour : novembre 2007
Vous devez fournir à vos utilisateurs une assistance et une documentation sur les composants que vous créez. Vous pouvez fournir cette assistance au moment du design, par le biais de métadonnées descriptives et au moment de l'exécution en appelant l'aide HTML.
Vous pouvez fournir des informations descriptives sur votre composant en recourant aux attributes. Les attributs sont des classes spécialisées attachées à d'autres classes ou membres de classe et émises vers des métadonnées au moment de la compilation. Ils peuvent fournir des informations à l'utilisateur ou directement à l'environnement de développement. Par exemple, l'attribut System.ComponentModel.DescriptionAttribute, lorsqu'il est attaché à une propriété ou à un événement, affiche une brève chaîne descriptive dans la fenêtre Propriétés. D'autres attributs affectent la manière dont l'environnement de développement se comporte avec le composant. Par exemple, l'attribut System.ComponentModel.BrowsableAttribute détermine si une propriété apparaît dans la fenêtre Propriétés.
En général, un composant ne fournit pas d'assistance à l'exécution, mais cela peut dans certains cas s'avérer utile. Par exemple, un composant très gros et complexe peut posséder une aide intégrée de sorte que les développeurs n'aient pas à écrire une importante documentation. La classe System.Windows.Forms.Help du .NET Framework encapsule le moteur HTML Help 1.x et peut être utilisée pour fournir de l'aide à vos utilisateurs au moment de l'exécution par le biais de fichiers HTML ou .chm. Pour plus d'informations, consultez Comment : spécifier un fichier d'aide pour votre composant.
Dans cette section
Comment : spécifier un fichier d'aide pour votre composant
Explique comment spécifier et afficher un fichier d'aide pour votre composant au moment de l'exécution.Comment : fournir des descriptions de métadonnées relatives à votre composant
Explique comment créer et attacher à votre composant des attributs descriptifs standard et personnalisés.Comment : fournir des métadonnées pour les propriétés, les méthodes et les événements
Explique comment attacher des attributs descriptifs à des membres de code.
Rubriques connexes
Vue d'ensemble des attributs
Offre une vue d'ensemble des attributs et de la manière dont ils sont utilisés dans le .NET Framework.Extension de la prise en charge au moment du design
Fournit des liens vers des rubriques sur l'intégration des composants et des contrôles dans l'environnement de design.