DescriptionAttribute Classe
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Specifica una descrizione per una proprietà o un 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- Ereditarietà
- Derivato
- Attributi
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 |
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. |
| IsDefaultAttribute() |
In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata. (Ereditato da Attribute) |
| 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) |
Implementazioni dell'interfaccia esplicita
| _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Esegue il mapping di un set di nomi a un set corrispondente di ID dispatch. (Ereditato da 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. (Ereditato da Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Recupera il numero delle interfacce di informazioni sul tipo fornite da un oggetto (0 o 1). (Ereditato da Attribute) |
| _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Fornisce l'accesso a proprietà e metodi esposti da un oggetto. (Ereditato da Attribute) |
