DescriptionAttribute DescriptionAttribute DescriptionAttribute DescriptionAttribute Class

Definition

Gibt die Beschreibung einer Eigenschaft oder eines Ereignisses an.Specifies a description for a property or event.

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

Beispiele

Das folgende Beispiel erstellt die MyImage Eigenschaft.The following example creates the MyImage property. Die Eigenschaft verfügt über zwei Attribute, einen DescriptionAttribute und 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

Im nächsten Beispiel wird die Beschreibung des MyImage.The next example gets the description of MyImage. Zuerst der Code Ruft eine PropertyDescriptorCollection mit allen Eigenschaften für das Objekt.First the code gets a PropertyDescriptorCollection with all the properties for the object. Als Nächstes indiziert in der PropertyDescriptorCollection abzurufenden MyImage.Next it indexes into the PropertyDescriptorCollection to get MyImage. Klicken Sie dann diese gibt die Attribute für diese Eigenschaft zurück und speichert sie in der Variablen Attributes.Then it returns the attributes for this property and saves them in the attributes variable.

Im Beispiel druckt die Beschreibung durch Abrufen von DescriptionAttribute aus der AttributeCollection, und sie an die Konsole geschrieben.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)

Hinweise

Ein visueller Designer kann die angegebene Beschreibung anzeigen, bei der, wie z. B. in einem Eigenschaftenfenster Komponentenmember.A visual designer can display the specified description when referencing the component member, such as in a Properties window. Rufen Sie Description Zugriff auf den Wert dieses Attributs.Call Description to access the value of this attribute.

Weitere Informationen finden Sie unter Attribute.For more information, see Attributes.

Konstruktoren

DescriptionAttribute() DescriptionAttribute() DescriptionAttribute() DescriptionAttribute()

Initialisiert eine neue Instanz der DescriptionAttribute-Klasse ohne Parameter.Initializes a new instance of the DescriptionAttribute class with no parameters.

DescriptionAttribute(String) DescriptionAttribute(String) DescriptionAttribute(String) DescriptionAttribute(String)

Initialisiert eine neue Instanz der DescriptionAttribute-Klasse mit einer Beschreibung.Initializes a new instance of the DescriptionAttribute class with a description.

Felder

Default Default Default Default

Gibt den Standardwert für das DescriptionAttribute an, der eine leere Zeichenfolge ("") ist.Specifies the default value for the DescriptionAttribute, which is an empty string (""). Dieses static-Feld ist schreibgeschützt.This static field is read-only.

Eigenschaften

Description Description Description Description

Ruft die in diesem Attribut gespeicherte Beschreibung ab.Gets the description stored in this attribute.

DescriptionValue DescriptionValue DescriptionValue DescriptionValue

Ruft die als Beschreibung gespeicherte Zeichenfolge ab oder legt diese fest.Gets or sets the string stored as the description.

TypeId TypeId TypeId TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methoden

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Gibt zurück, ob der Wert des angegebenen Objekts gleich dem aktuellen DescriptionAttribute ist.Returns whether the value of the given object is equal to the current DescriptionAttribute.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Gibt einen Wert zurück, der angibt, ob dies die Standard-DescriptionAttribute-Instanz ist.Returns a value indicating whether this is the default DescriptionAttribute instance.

Match(Object) Match(Object) Match(Object) Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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.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) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 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) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Gilt für:

Siehe auch