DescriptionAttribute-Klasse
Gibt eine Beschreibung für eine Eigenschaft oder ein Ereignis an.
Namespace: System.ComponentModel
Assembly: System (in system.dll)
Syntax
'Declaration
<AttributeUsageAttribute(AttributeTargets.All)> _
Public Class DescriptionAttribute
Inherits Attribute
'Usage
Dim instance As DescriptionAttribute
[AttributeUsageAttribute(AttributeTargets.All)]
public class DescriptionAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::All)]
public ref class DescriptionAttribute : public Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.All) */
public class DescriptionAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.All)
public class DescriptionAttribute extends Attribute
Hinweise
Ein visueller Designer kann die angegebene Beschreibung beim Verweisen auf den Komponentenmember anzeigen, z. B. in einem Eigenschaftenfenster. Rufen Sie Description auf, um auf den Wert dieses Attributs zuzugreifen.
Weitere Informationen finden Sie unter Übersicht über Attribute und Erweitern von Metadaten mithilfe von Attributen.
Beispiel
Im folgenden Beispiel wird die MyImage-Eigenschaft erstellt. Die Eigenschaft verfügt über zwei Attribute: DescriptionAttribute und CategoryAttribute.
<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
[Description("The image associated with the control"),Category("Appearance")]
public Image MyImage {
get {
// Insert code here.
return image1;
}
set {
// Insert code here.
}
}
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.
}
}
/** @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
Im nächsten Beispiel wird die Beschreibung von MyImage abgerufen. Zunächst wird im Code eine PropertyDescriptorCollection mit allen Eigenschaften für das Objekt abgerufen. Anschließend wird MyImage über den Index in PropertyDescriptorCollection abgerufen. Die Attribute für diese Eigenschaft werden zurückgegeben und in der Variablen attributes gespeichert.
Im Beispiel erfolgt dann eine Ausgabe der Beschreibung auf dem Konsolenbildschirm, indem DescriptionAttribute aus AttributeCollection abgerufen wird.
' 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)
// 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.
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).
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());
Vererbungshierarchie
System.Object
System.Attribute
System.ComponentModel.DescriptionAttribute
Abgeleitete Klassen
Threadsicherheit
Alle öffentlichen statischen (Shared in Visual Basic) Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.
Plattformen
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.
Versionsinformationen
.NET Framework
Unterstützt in: 2.0, 1.1, 1.0
Siehe auch
Referenz
DescriptionAttribute-Member
System.ComponentModel-Namespace
Attribute
PropertyDescriptor
EventDescriptor