DescriptionAttribute Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Especifica una descripción para una propiedad o evento.
public ref class DescriptionAttribute : Attribute[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attributepublic class DescriptionAttribute : Attribute[<System.AttributeUsage(System.AttributeTargets.All)>]
type DescriptionAttribute = class
inherit Attributetype DescriptionAttribute = class
inherit AttributePublic Class DescriptionAttribute
Inherits Attribute- Herencia
- Derivado
- Atributos
Ejemplos
En el ejemplo siguiente se crea la MyImage propiedad . La propiedad tiene dos atributos, y DescriptionAttribute .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. En primer lugar, el código obtiene con PropertyDescriptorCollection todas las propiedades del objeto . A continuación, se indexa en para PropertyDescriptorCollection obtener MyImage. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable attributes.
A continuación, en el ejemplo se imprime la descripción recuperando DescriptionAttribute de AttributeCollectiony escribiendola 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 );
// 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 al hacer referencia al miembro del componente, como en un ventana Propiedades. Llame Description a para tener acceso al valor de este atributo.
Para obtener más información, consulte Attributes (Atributos).
Constructores
| DescriptionAttribute() |
Inicializa una nueva instancia de la clase DescriptionAttribute sin ningún parámetro. |
| DescriptionAttribute(String) |
Inicializa una nueva instancia de la clase DescriptionAttribute con una descripción. |
Campos
| Default |
Especifica el valor predeterminado de DescriptionAttribute, que es una cadena vacía (""). Este campo |
Propiedades
| Description |
Obtiene la descripción almacenada en este atributo. |
| DescriptionValue |
Obtiene o establece la cadena almacenada como descripción. |
| TypeId |
Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute) |
Métodos
| Equals(Object) |
Devuelve un valor que indica si el valor del objeto especificado es igual al atributo DescriptionAttribute actual. |
| GetHashCode() |
Devuelve el código hash de esta instancia. |
| GetType() |
Obtiene el Type de la instancia actual. (Heredado de Object) |
| IsDefaultAttribute() |
Devuelve un valor que indica si ésta es la instancia DescriptionAttribute predeterminada. |
| IsDefaultAttribute() |
Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute) |
| Match(Object) |
Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute) |
| MemberwiseClone() |
Crea una copia superficial del Object actual. (Heredado de Object) |
| ToString() |
Devuelve una cadena que representa el objeto actual. (Heredado de 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. (Heredado de 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. (Heredado de Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1). (Heredado de Attribute) |
| _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) |
