DescriptionAttribute DescriptionAttribute DescriptionAttribute DescriptionAttribute Class

Définition

Spécifie une description pour une propriété ou un événement.Specifies a description for a property or event.

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

Exemples

L’exemple suivant crée la MyImage propriété.The following example creates the MyImage property. La propriété a deux attributs, un DescriptionAttribute et un CategoryAttribute.The property has two attributes, a DescriptionAttribute and 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.
       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.The next example gets the description of MyImage. Tout d’abord, le PropertyDescriptorCollection code obtient un avec toutes les propriétés de l’objet.First the code gets a PropertyDescriptorCollection with all the properties for the object. Ensuite, il indexe dans PropertyDescriptorCollection le à MyImagerécupérer.Next it indexes into the PropertyDescriptorCollection to get MyImage. Elle retourne ensuite les attributs de cette propriété et les enregistre dans la variable d’attributs.Then it returns the attributes for this property and saves them in the attributes variable.

L’exemple imprime ensuite la description en extrayant DescriptionAttribute AttributeCollectiondu et en l’écrivant sur l’écran de la console.The example then prints the description by retrieving DescriptionAttribute from the AttributeCollection, and writing it to the console screen.

// 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.A visual designer can display the specified description when referencing the component member, such as in a Properties window. Appelez Description pour accéder à la valeur de cet attribut.Call Description to access the value of this attribute.

Pour plus d’informations, consultez Attributs.For more information, see Attributes.

Constructeurs

DescriptionAttribute() DescriptionAttribute() DescriptionAttribute() DescriptionAttribute()

Initialise une nouvelle instance de la classe DescriptionAttribute sans paramètres.Initializes a new instance of the DescriptionAttribute class with no parameters.

DescriptionAttribute(String) DescriptionAttribute(String) DescriptionAttribute(String) DescriptionAttribute(String)

Initialise une nouvelle instance de la classe DescriptionAttribute avec une description.Initializes a new instance of the DescriptionAttribute class with a description.

Champs

Default Default Default Default

Spécifie la valeur par défaut de DescriptionAttribute (chaîne vide ("")).Specifies the default value for the DescriptionAttribute, which is an empty string (""). Ce champ static est en lecture seule.This static field is read-only.

Propriétés

Description Description Description Description

Obtient la description stockée dans cet attribut.Gets the description stored in this attribute.

DescriptionValue DescriptionValue DescriptionValue DescriptionValue

Obtient ou définit la chaîne stockée comme description.Gets or sets the string stored as the description.

TypeId TypeId TypeId TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Méthodes

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Retourne une valeur indiquant si la valeur de l'objet donné est égale au DescriptionAttribute en cours.Returns whether the value of the given object is equal to the current DescriptionAttribute.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Retourne le code de hachage de cette instance.Returns the hash code for this instance.

GetType() GetType() GetType() GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Retourne une valeur qui indique s'il s'agit de l'instance DescriptionAttribute par défaut.Returns a value indicating whether this is the default DescriptionAttribute instance.

Match(Object) Match(Object) Match(Object) Match(Object)

En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)

Implémentations d’interfaces explicites

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

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _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.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

S’applique à

Voir aussi