Evaluar y enviar comentarios
Contraer todo/Expandir todo Contraer todo
Esta página es específica de
Microsoft Visual Studio 2005/.NET Framework 2.0

Hay además otras versiones disponibles para:
Biblioteca de clases de .NET Framework
DescriptionAttribute (Clase)

Especifica una descripción para una propiedad o para un evento.

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

Visual Basic (Declaración)
<AttributeUsageAttribute(AttributeTargets.All)> _
Public Class DescriptionAttribute
    Inherits Attribute
Visual Basic (Uso)
Dim instance As DescriptionAttribute
C#
[AttributeUsageAttribute(AttributeTargets.All)] 
public class DescriptionAttribute : Attribute
C++
[AttributeUsageAttribute(AttributeTargets::All)] 
public ref class DescriptionAttribute : public Attribute
J#
/** @attribute AttributeUsageAttribute(AttributeTargets.All) */ 
public class DescriptionAttribute extends Attribute
JScript
AttributeUsageAttribute(AttributeTargets.All) 
public class DescriptionAttribute extends Attribute

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

Para obtener más información, vea Información general sobre atributos y Extender metadatos mediante atributos.

En el siguiente ejemplo se crea la propiedad MyImage. Esta propiedad tiene dos atributos: DescriptionAttribute y CategoryAttribute.

Visual Basic
<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
C#
[Description("The image associated with the control"),Category("Appearance")] 
 public Image MyImage {
    get {
       // Insert code here.
       return image1;
    }
    set {
       // Insert code here.
    }
 }
C++
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.
      }
   }
J#
/** @attribute Description("The image associated with the control")
    @attribute Category("Appearance")
 */
/** @property 
 */
public Image get_MyImage()
{
    // Insert code here.
    return image1;
} //get_MyImage

/** @property 
 */
public void set_MyImage(Image value)
{
    // Insert code here.
} //set_MyImage

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

A continuación, el ejemplo imprime la descripción recuperando DescriptionAttribute de AttributeCollection y escribiéndolo en la pantalla de la consola.

Visual Basic
' 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)
C#
// 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);
C++
// 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 );
J#
// Gets the attributes for the property.
AttributeCollection attributes = TypeDescriptor.GetProperties(this).
    get_Item("MyImage").get_Attributes();

/* Prints the description by retrieving the DescriptionAttribute 
   from the AttributeCollection. 
 */
DescriptionAttribute myAttribute = (DescriptionAttribute)(attributes.
    get_Item(DescriptionAttribute.class.ToType()));

Console.WriteLine(myAttribute.get_Description());
System.Object
   System.Attribute
    System.ComponentModel.DescriptionAttribute
       Clases derivadas
Los miembros estáticos públicos (Shared en Visual Basic) de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.

Windows 98, Windows 2000 SP4, Windows Millennium, Windows Server 2003, Windows XP Media Center, Windows XP Professional x64, Windows XP SP2, Windows XP Starter Edition

.NET Framework no admite todas las versiones de cada plataforma. Para obtener una lista de las versiones admitidas, vea Requisitos del sistema.

.NET Framework

Compatible con: 2.0, 1.1, 1.0
Contenido de la comunidad   ¿Qué es Community Content?
Agregar contenido nuevo RSS  Anotaciones
Processing
© 2009 Microsoft Corporation. Reservados todos los derechos. Términos de uso | Marcas Registradas | Privacidad
Page view tracker