DescriptionAttribute Classe

Definizione

Spazio dei nomi:

System.ComponentModel

Assembly:

System.ComponentModel.Primitives.dll

Source:

DescriptionAttribute.cs

Specifica una descrizione per una proprietà o un 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

Ereditarietà

Object

Attribute

DescriptionAttribute

Derivato

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

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio seguente viene creata la MyImage proprietà . La proprietà ha due attributi, un DescriptionAttribute e 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.
      }
   }

[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

Nell'esempio seguente viene recuperata la descrizione di MyImage. Prima di tutto, il codice ottiene un PropertyDescriptorCollection oggetto con tutte le proprietà per l'oggetto . Successivamente, indicizza in PropertyDescriptorCollection per ottenere MyImage. Restituisce quindi gli attributi per questa proprietà e li salva nella variabile degli attributi.

L'esempio stampa quindi la descrizione recuperando DescriptionAttribute dall'oggetto AttributeCollectione scrivendola nella schermata della console.

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

Commenti

Una finestra di progettazione visiva può visualizzare la descrizione specificata quando si fa riferimento al membro del componente, ad esempio in un Finestra Proprietà. Chiamare Description per accedere al valore di questo attributo.

Per altre informazioni, vedere Attributi.

Costruttori

DescriptionAttribute()	Consente di inizializzare una nuova istanza della classe DescriptionAttribute senza parametri.
DescriptionAttribute(String)	Consente di inizializzare una nuova istanza della classe DescriptionAttribute con una descrizione.

Campi

Default

Consente di specificare il valore predefinito per DescriptionAttribute, che è una stringa vuota (""). Questo campo static è di sola lettura.

Proprietà

Description	Ottiene la descrizione memorizzata in questo attributo.
DescriptionValue	Ottiene o imposta la stringa memorizzata come descrizione.
TypeId	Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute)

Metodi

Equals(Object)	Specifica se il valore dell'oggetto specificato è uguale all'oggetto DescriptionAttribute corrente.
GetHashCode()	Restituisce il codice hash per l'istanza.
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	Restituisce un valore che indica se si tratta dell'istanza predefinita di DescriptionAttribute.
Match(Object)	Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

Vedi anche

• Attribute
• PropertyDescriptor
• EventDescriptor