DescriptionAttribute Klasse

Definition

Gibt die Beschreibung einer Eigenschaft oder eines Ereignisses an.

public ref class DescriptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attribute
public class DescriptionAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.All)>]
type DescriptionAttribute = class
    inherit Attribute
type DescriptionAttribute = class
    inherit Attribute
Public Class DescriptionAttribute
Inherits Attribute
Vererbung
DescriptionAttribute
Abgeleitet
Attribute

Beispiele

Im folgenden Beispiel wird die MyImage Eigenschaft erstellt. Die Eigenschaft verfügt über zwei Attribute, eine DescriptionAttribute und eine 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 MyImage. Zunächst ruft der Code alle PropertyDescriptorCollection Eigenschaften für das Objekt ab. Als Nächstes wird die Indizes in das PropertyDescriptorCollection zu abrufende MyImageIndizes eingefügt. Anschließend gibt sie die Attribute für diese Eigenschaft zurück und speichert sie in der Attributevariable.

Im Beispiel wird dann die Beschreibung gedruckt, indem sie aus dem AttributeCollectionKonsolenbildschirm 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 beim Verweisen auf das Komponentenelement anzeigen, z. B. in einem Eigenschaftenfenster. Rufen Sie Description auf den Wert dieses Attributs zu.

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.

IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.

(Geerbt von Attribute)
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)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.

(Geerbt von Attribute)

Gilt für

Siehe auch