DescriptionAttribute Class

Definición

Especifica una descripción para una propiedad o evento. Specifies a description for a property or event.

[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attribute
Herencia
DescriptionAttribute
Derivado
Atributos

Ejemplos

En el ejemplo siguiente se crea el MyImage propiedad.The following example creates the MyImage property. La propiedad tiene dos atributos, un DescriptionAttribute y 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

En el ejemplo siguiente se obtiene la descripción de MyImage.The next example gets the description of MyImage. En primer lugar, el código obtiene una PropertyDescriptorCollection con todas las propiedades del objeto.First the code gets a PropertyDescriptorCollection with all the properties for the object. A continuación indiza en la PropertyDescriptorCollection obtener MyImage.Next it indexes into the PropertyDescriptorCollection to get MyImage. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable de atributos.Then it returns the attributes for this property and saves them in the attributes variable.

En el ejemplo, a continuación, imprime la descripción recuperando DescriptionAttribute desde el AttributeCollectiony escribirlo en la pantalla de la consola.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)

Comentarios

Un diseñador visual puede mostrar la descripción especificada cuando se hace referencia al miembro del componente, como en una ventana de propiedades.A visual designer can display the specified description when referencing the component member, such as in a Properties window. Llame a Description para acceder al valor de este atributo.Call Description to access the value of this attribute.

Para obtener más información, consulte Attributes (Atributos).For more information, see Attributes.

Constructores

DescriptionAttribute()

Inicializa una nueva instancia de la clase DescriptionAttribute sin ningún parámetro. Initializes a new instance of the DescriptionAttribute class with no parameters.

DescriptionAttribute(String)

Inicializa una nueva instancia de la clase DescriptionAttribute con una descripción. Initializes a new instance of the DescriptionAttribute class with a description.

Campos

Default

Especifica el valor predeterminado de DescriptionAttribute, que es una cadena vacía (""). Specifies the default value for the DescriptionAttribute, which is an empty string (""). Este campo static es de solo lectura. This static field is read-only.

Propiedades

Description

Obtiene la descripción almacenada en este atributo. Gets the description stored in this attribute.

DescriptionValue

Obtiene o establece la cadena almacenada como descripción. Gets or sets the string stored as the description.

TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Métodos

Equals(Object)

Devuelve un valor que indica si el valor del objeto especificado es igual al atributo DescriptionAttribute actual. Returns whether the value of the given object is equal to the current DescriptionAttribute.

GetHashCode()

Devuelve el código hash de esta instancia. Returns the hash code for this instance.

GetType()

Obtiene el Type de la instancia actual. Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

Devuelve un valor que indica si ésta es la instancia DescriptionAttribute predeterminada. Returns a value indicating whether this is the default DescriptionAttribute instance.

Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Crea una copia superficial del Object actual. Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Devuelve una cadena que representa el objeto actual. Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

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

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío. Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz. 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)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 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)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto. Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a

Consultar también