DescriptionAttribute Klasse

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.Primitives.dll

Quelle:

DescriptionAttribute.cs

Gibt die Beschreibung einer Eigenschaft oder eines Ereignisses an.

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

Vererbung

Object

Attribute

DescriptionAttribute

Abgeleitet

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

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird die MyImage -Eigenschaft erstellt. Die -Eigenschaft verfügt über zwei Attribute: ein DescriptionAttribute und ein 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

Im nächsten Beispiel wird die Beschreibung von MyImageabgerufen. Zuerst ruft der Code eine PropertyDescriptorCollection mit allen Eigenschaften für das -Objekt ab. Als Nächstes wird in die PropertyDescriptorCollection indiziert, um abzurufen MyImage. Anschließend werden die Attribute für diese Eigenschaft zurückgegeben und in der Variablen attributes gespeichert.

Im Beispiel wird dann die Beschreibung ausgegeben, indem aus AttributeCollectionder abgerufen DescriptionAttribute und in den Konsolenbildschirm geschrieben wird.

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

Hinweise

Ein visueller Designer kann die angegebene Beschreibung anzeigen, wenn auf den Komponentenmember verwiesen wird, z. B. in einem Eigenschaftenfenster. Rufen Sie Description auf, um auf den Wert dieses Attributs zuzugreifen.

Weitere Informationen finden Sie unter Attribute.

Konstruktoren

DescriptionAttribute()	Initialisiert eine neue Instanz der DescriptionAttribute-Klasse ohne Parameter.
DescriptionAttribute(String)	Initialisiert eine neue Instanz der DescriptionAttribute-Klasse mit einer Beschreibung.

Felder

Default

Gibt den Standardwert für das DescriptionAttribute an, der eine leere Zeichenfolge ("") ist. Dieses static-Feld ist schreibgeschützt.

Eigenschaften

Description	Ruft die in diesem Attribut gespeicherte Beschreibung ab.
DescriptionValue	Ruft die als Beschreibung gespeicherte Zeichenfolge ab oder legt diese fest.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt zurück, ob der Wert des angegebenen Objekts gleich dem aktuellen DescriptionAttribute ist.
GetHashCode()	Gibt den Hashcode für diese Instanz zurück.
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt einen Wert zurück, der angibt, ob dies die Standard-DescriptionAttribute-Instanz ist.
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• Attribute
• PropertyDescriptor
• EventDescriptor