DescriptionAttribute Class

Definition

Specifica una descrizione per una proprietà o un evento.Specifies a description for a property or event.

public ref class DescriptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attribute
public class DescriptionAttribute : Attribute
type DescriptionAttribute = class
    inherit Attribute
Public Class DescriptionAttribute
Inherits Attribute
Inheritance
DescriptionAttribute
Derived
Attributes

Examples

Nell'esempio seguente viene creata la proprietà MyImage.The following example creates the MyImage property. La proprietà dispone di due attributi, un DescriptionAttribute e una CategoryAttribute.The property has two attributes, a DescriptionAttribute and a 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 ottenuta la descrizione di MyImage.The next example gets the description of MyImage. Prima di tutto il codice ottiene un PropertyDescriptorCollection con tutte le proprietà per l'oggetto.First the code gets a PropertyDescriptorCollection with all the properties for the object. Successivamente, indicizza nel PropertyDescriptorCollection per ottenere MyImage.Next it indexes into the PropertyDescriptorCollection to get MyImage. Restituisce quindi gli attributi per questa proprietà e li salva nella variabile Attributes.Then it returns the attributes for this property and saves them in the attributes variable.

Nell'esempio viene quindi stampata la descrizione recuperando DescriptionAttribute dal AttributeCollectione scrivendola nella schermata della console.The example then prints the description by retrieving DescriptionAttribute from the AttributeCollection, and writing it to the console screen.

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

Remarks

Una finestra di progettazione visiva può visualizzare la descrizione specificata quando fa riferimento al membro del componente, ad esempio in un Finestra Proprietà.A visual designer can display the specified description when referencing the component member, such as in a Properties window. Chiamare Description per accedere al valore di questo attributo.Call Description to access the value of this attribute.

Per altre informazioni, vedere Attributi.For more information, see Attributes.

Constructors

DescriptionAttribute()

Consente di inizializzare una nuova istanza della classe DescriptionAttribute senza parametri.Initializes a new instance of the DescriptionAttribute class with no parameters.

DescriptionAttribute(String)

Consente di inizializzare una nuova istanza della classe DescriptionAttribute con una descrizione.Initializes a new instance of the DescriptionAttribute class with a description.

Fields

Default

Consente di specificare il valore predefinito per DescriptionAttribute, che è una stringa vuota ("").Specifies the default value for the DescriptionAttribute, which is an empty string (""). Questo campo static è di sola lettura.This static field is read-only.

Properties

Description

Ottiene la descrizione memorizzata in questo attributo.Gets the description stored in this attribute.

DescriptionValue

Ottiene o imposta la stringa memorizzata come descrizione.Gets or sets the string stored as the description.

TypeId

Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Specifica se il valore dell'oggetto specificato è uguale all'oggetto DescriptionAttribute corrente.Returns whether the value of the given object is equal to the current DescriptionAttribute.

GetHashCode()

Restituisce il codice hash relativo a questa istanza.Returns the hash code for this instance.

GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

Restituisce un valore che indica se si tratta dell'istanza predefinita di DescriptionAttribute.Returns a value indicating whether this is the default DescriptionAttribute instance.

IsDefaultAttribute()

In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Esegue il mapping di un set di nomi a un set corrispondente di ID dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera le informazioni sul tipo relative a un oggetto, che possono essere usate per ottenere informazioni sul tipo relative a un'interfaccia.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera il numero delle interfacce di informazioni sul tipo fornite da un oggetto (0 o 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornisce l'accesso a proprietà e metodi esposti da un oggetto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See also