Comment : fournir des métadonnées pour les propriétés, les méthodes et les événements

Vous pouvez attacher des métadonnées descriptives à vos propriétés, méthodes et événements en vous servant des attributs. Les attributs sont des classes spécialisées qui modifient les éléments de code et sont émis vers des métadonnées relatives à ces éléments de code au moment de la compilation. Les attributs au moment du design interagissent avec l'environnement de développement pour fournir au développeur des informations sur votre composant. DescriptionAttribute est, par exemple, un attribut couramment utilisé. Lorsqu'il est attaché à une propriété ou à un événement, l'attribut DescriptionAttribute entraîne l'affichage d'une courte chaîne dans la fenêtre Propriétés. Voici un exemple :

Imports System.ComponentModel
<Description("This property specifies the active Widget")> Public _
   Property ActiveWidget as Widget
' Insert code to implementat functionality.
End Property
using System.ComponentModel;
[Description("This property specifies the active Widget")]
public Widget ActiveWidget
{
   // Insert code to implementat functionality.
}

Pour plus d'informations sur les attributs que vous pouvez utiliser pour améliorer la prise en charge de votre composant au moment du design, consultez Attributs en mode design pour les composants.

Pour attacher un attribut à une propriété, une méthode ou un événement

  • Ajoutez un appel au constructeur de l'attribut dans l'élément de code à modifier. Pour ajouter l'appel, placez-le entre crochets pointus <> (pour Visual Basic) ou entre crochets droits [] (pour C#), devant l'élément de code à modifier.

    <Browsable(False)> Public Property ServingSize as Integer
    
    [Browsable(false)]
    public int ServingSize
    

Voir aussi

Tâches

Comment : fournir des descriptions de métadonnées relatives à votre composant

Référence

Attribute

Concepts

Attributs en mode design pour les composants

Accès aux attributs personnalisés

Récupération des informations stockées dans les attributs

Autres ressources

Assistance utilisateur pour les composants