DescriptionAttribute Clase

Definición

Espacio de nombres:

System.ComponentModel

Ensamblado:

System.ComponentModel.Primitives.dll

Source:

DescriptionAttribute.cs

Especifica una descripción para una propiedad o evento.

public ref class DescriptionAttribute : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.All)>]
type DescriptionAttribute = class
    inherit Attribute

Public Class DescriptionAttribute
Inherits Attribute

Herencia

Object

Attribute

DescriptionAttribute

Derivado

Microsoft.VisualBasic.Compatibility.VB6.SRDescriptionAttribute

System.Data.DataSysDescriptionAttribute

System.Diagnostics.MonitoringDescriptionAttribute

System.DirectoryServices.DSDescriptionAttribute

System.IO.IODescriptionAttribute

System.Messaging.MessagingDescriptionAttribute

System.ServiceProcess.ServiceProcessDescriptionAttribute

System.Timers.TimersDescriptionAttribute

Atributos

AttributeUsageAttribute

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 static es de solo lectura.

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.
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)

Consulte también

• Attribute
• PropertyDescriptor
• EventDescriptor