DescriptionAttribute Classe

Définition

Espace de noms:
System.ComponentModel
Assembly:
System.dll
Assembly:
netstandard.dll

Spécifie une description pour une propriété ou un événement.

public ref class DescriptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.All)>]
type DescriptionAttribute = class
    inherit Attribute
Public Class DescriptionAttribute
Inherits Attribute
Héritage
Object
Attribute
DescriptionAttribute
Dérivé
Attributs
AttributeUsageAttribute

Exemples

L’exemple suivant crée la MyImage propriété. La propriété a deux attributs, a DescriptionAttribute et a CategoryAttribute.

public:
   property Image^ MyImage 
   {
      [Description("The image associated with the control"),Category("Appearance")]
      Image^ get()
      {
         // Insert code here.
         return image1;
      }

      void set( Image^ value )
      {
         // Insert code here.
      }
   }

[Description("The image associated with the control"), Category("Appearance")]
public Image MyImage
{
    get =>
        // Insert code here.
        image1;
    set
    {
        // Insert code here.
    }
}

<Description("The image associated with the control"), _
    Category("Appearance")> _
Public Property MyImage() As Image
    Get
        ' Insert code here.
        Return image1
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

L’exemple suivant obtient la description de MyImage. Tout d’abord, le code obtient une PropertyDescriptorCollection valeur avec toutes les propriétés de l’objet. Ensuite, il indexe dans le PropertyDescriptorCollection fichier pour obtenir MyImage. Ensuite, elle retourne les attributs de cette propriété et les enregistre dans la variable d’attributs.

L’exemple imprime ensuite la description en récupérant DescriptionAttribute à partir de l’écran AttributeCollectionde console et en l’écrivant dans l’écran de console.

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this )[ "MyImage" ]->Attributes;

/* Prints the description by retrieving the DescriptionAttribute 
      * from the AttributeCollection. */
DescriptionAttribute^ myAttribute = dynamic_cast<DescriptionAttribute^>(attributes[ DescriptionAttribute::typeid ]);
Console::WriteLine( myAttribute->Description );

// Gets the attributes for the property.
AttributeCollection attributes =
   TypeDescriptor.GetProperties(this)["MyImage"].Attributes;

/* Prints the description by retrieving the DescriptionAttribute 
 * from the AttributeCollection. */
DescriptionAttribute myAttribute =
   (DescriptionAttribute)attributes[typeof(DescriptionAttribute)];
Console.WriteLine(myAttribute.Description);

' Gets the attributes for the property.
Dim attributes As AttributeCollection = _
    TypeDescriptor.GetProperties(Me)("MyImage").Attributes

' Prints the description by retrieving the DescriptionAttribute
' from the AttributeCollection. 
Dim myAttribute As DescriptionAttribute = _
    CType(attributes(GetType(DescriptionAttribute)), DescriptionAttribute)
Console.WriteLine(myAttribute.Description)

Remarques

Un concepteur visuel peut afficher la description spécifiée lors du référencement du membre du composant, par exemple dans un Fenêtre Propriétés. Appelez Description pour accéder à la valeur de cet attribut.

Pour plus d’informations, consultez Attributs.

Constructeurs

Nom Description
DescriptionAttribute()

Initialise une nouvelle instance de la DescriptionAttribute classe sans paramètres.
DescriptionAttribute(String)

Initialise une nouvelle instance de la DescriptionAttribute classe avec une description.

Champs

Nom Description
Default

Spécifie la valeur par défaut pour le DescriptionAttribute, qui est une chaîne vide ( » « ). Ce static champ est en lecture seule.

Propriétés

Nom Description
Description

Obtient la description stockée dans cet attribut.
DescriptionValue

Obtient ou définit la chaîne stockée en tant que description.
TypeId

En cas d’implémentation dans une classe dérivée, obtient un identificateur unique pour cette Attribute.

(Hérité de Attribute)

Méthodes

Nom Description
Equals(Object)

Retourne si la valeur de l’objet donné est égale à la valeur actuelle DescriptionAttribute.
GetHashCode()

Retourne le code de hachage pour cette instance.
GetType()

Obtient la Type de l’instance actuelle.

(Hérité de Object)
IsDefaultAttribute()

Retourne une valeur indiquant s’il s’agit de l’instance par défaut DescriptionAttribute .
IsDefaultAttribute()

En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut de la classe dérivée.

(Hérité de Attribute)
Match(Object)

En cas de substitution dans une classe dérivée, retourne une valeur qui indique si cette instance est égale à un objet spécifié.

(Hérité de Attribute)
MemberwiseClone()

Crée une copie superficielle du Objectactuel.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l’objet actuel.

(Hérité de Object)

Implémentations d’interfaces explicites

Nom Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.

(Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Récupère les informations de type d’un objet, qui peuvent être utilisées pour obtenir les informations de type d’une interface.

(Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).

(Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fournit l’accès aux propriétés et méthodes exposées par un objet.

(Hérité de Attribute)

S’applique à

Voir aussi