DescriptionAttribute Classe

  • Référence

Définition

Espace de noms:
System.ComponentModel
Assembly:
System.ComponentModel.Primitives.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Source:
DescriptionAttribute.cs
Source:
DescriptionAttribute.cs
Source:
DescriptionAttribute.cs

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
public class DescriptionAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.All)>]
type DescriptionAttribute = class
    inherit Attribute
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, un DescriptionAttribute et un 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.
       return 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 un PropertyDescriptorCollection avec toutes les propriétés de l’objet. Ensuite, il s’indexe dans pour PropertyDescriptorCollection obtenir MyImage. Ensuite, il 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 à partir de et AttributeCollectionen l’écrivant DescriptionAttribute dans l’écran de la 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

DescriptionAttribute()

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

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

Champs

Default

Spécifie la valeur par défaut de DescriptionAttribute (chaîne vide ("")). Ce champ static est en lecture seule.

Propriétés

Description

Obtient la description stockée dans cet attribut.
DescriptionValue

Obtient ou définit la chaîne stockée comme description.
TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.

(Hérité de Attribute)

Méthodes

Equals(Object)

Retourne une valeur indiquant si la valeur de l'objet donné est égale au DescriptionAttribute en cours.
GetHashCode()

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

Obtient le Type de l'instance actuelle.

(Hérité de Object)
IsDefaultAttribute()

Retourne une valeur qui indique s'il s'agit de l'instance DescriptionAttribute par défaut.
IsDefaultAttribute()

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

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

En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.

(Hérité de Attribute)
MemberwiseClone()

Crée une copie superficielle du Object actuel.

(Hérité de Object)
ToString()

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

(Hérité de Object)

Implémentations d’interfaces explicites

_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 pour 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 aux méthodes exposées par un objet.

(Hérité de Attribute)

S’applique à

Voir aussi