Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si mueve el puntero del mouse sobre el texto.
Traducción
Inglés

Clase DescriptionAttribute

 

Especifica una descripción para una propiedad o evento.

Espacio de nombres:   System.ComponentModel
Ensamblado:  System (en System.dll)


[AttributeUsageAttribute(AttributeTargets::All)]
public ref class DescriptionAttribute : Attribute

NombreDescripción
System_CAPS_pubmethodDescriptionAttribute()

Inicializa una nueva instancia de la DescriptionAttribute clase sin parámetros.

System_CAPS_pubmethodDescriptionAttribute(String^)

Inicializa una nueva instancia de la DescriptionAttribute clase con una descripción.

NombreDescripción
System_CAPS_pubpropertyDescription

Obtiene la descripción almacenada en este atributo.

System_CAPS_protpropertyDescriptionValue

Obtiene o establece la cadena almacenada como descripción.

System_CAPS_pubpropertyTypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.(Heredado de Attribute).

NombreDescripción
System_CAPS_pubmethodEquals(Object^)

Devuelve si el valor del objeto especificado es igual a la actual DescriptionAttribute.(Invalida Attribute::Equals(Object^)).

System_CAPS_protmethodFinalize()

Permite que un objeto intente liberar recursos y realizar otras operaciones de limpieza antes de ser reclamado por el recolector de basura. (Heredado de Object).

System_CAPS_pubmethodGetHashCode()

Devuelve el código hash de esta instancia.(Invalida Attribute::GetHashCode()).

System_CAPS_pubmethodGetType()

Obtiene el Type de la instancia actual.(Heredado de Object).

System_CAPS_pubmethodIsDefaultAttribute()

Devuelve un valor que indica si este es el valor predeterminado DescriptionAttribute instancia.(Invalida Attribute::IsDefaultAttribute()).

System_CAPS_pubmethodMatch(Object^)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual al objeto especificado. (Heredado de Attribute).

System_CAPS_protmethodMemberwiseClone()

Crea una copia superficial del Object actual.(Heredado de Object).

System_CAPS_pubmethodToString()

Retorna una cadena que representa al objeto actual. (Heredado de Object).

NombreDescripción
System_CAPS_pubfieldSystem_CAPS_staticDefault

Especifica el valor predeterminado para el DescriptionAttribute, que es una cadena vacía (""). Esto static campo es de solo lectura.

NombreDescripción
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetIDsOfNames(Guid%, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.(Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información del tipo de un objeto, que puede utilizarse para obtener la información del tipo de una interfaz. (Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetTypeInfoCount(UInt32%)

Recupera el número de interfaces de tipo de información que suministra un objeto (0 ó 1)

(Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::Invoke(UInt32, Guid%, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.(Heredado de Attribute).

Un diseñador visual puede mostrar la descripción especificada cuando se hace referencia al miembro del componente, como en una ventana de propiedades. Llame a Description para tener acceso al valor de este atributo.

Para obtener más información, consulta Extender metadatos mediante atributos.

En el ejemplo siguiente se crea el MyImage propiedad. La propiedad tiene dos atributos, un DescriptionAttribute y 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.
      }
   }

En el ejemplo siguiente se obtiene la descripción de MyImage. En primer lugar, el código obtiene una PropertyDescriptorCollection con todas las propiedades del objeto. A continuación, inserta un índice en la PropertyDescriptorCollection para obtener MyImage. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable de atributos.

A continuación, imprime la descripción recuperando DescriptionAttribute desde el AttributeCollection, y escribir en la pantalla de la consola.

// 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 );

.NET Framework
Disponible desde 1.1
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0

Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Volver al principio
Mostrar: