DescriptionAttribute Klasse

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
DescriptionAttribute
Abgeleitet
Attribute

Beispiele

Im folgenden Beispiel wird die MyImage -Eigenschaft erstellt.The following example creates the MyImage property. DescriptionAttribute DieCategoryAttribute-Eigenschaft verfügt über zwei Attribute: und.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 von MyImageabgerufen.The next example gets the description of MyImage. Zuerst ruft der Code ein PropertyDescriptorCollection -Objekt mit allen Eigenschaften für das-Objekt ab.First the code gets a PropertyDescriptorCollection with all the properties for the object. Im nächsten Schritt wird der PropertyDescriptorCollection zum erhalten MyImageindiziert.Next it indexes into the PropertyDescriptorCollection to get MyImage. Anschließend werden die Attribute für diese Eigenschaft zurückgegeben und in der Attribut Variablen gespeichert.Then it returns the attributes for this property and saves them in the attributes variable.

Im Beispiel wird dann die Beschreibung ausgegeben DescriptionAttribute AttributeCollection, indem vom abgerufen und in den Konsolenbildschirm geschrieben wird.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 beim Verweis auf den Komponentenmember anzeigen, z. b. in einem Eigenschaftenfenster.A visual designer can display the specified description when referencing the component member, such as in a Properties window. Aufrufen Description , um auf den Wert dieses Attributs zuzugreifen.Call Description to access the value of this attribute.

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

Konstruktoren

DescriptionAttribute()

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

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

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

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

DescriptionValue

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

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.

(Geerbt von Attribute)

Methoden

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

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

GetType()

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

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

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.

(Geerbt von Attribute)
MemberwiseClone()

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

(Geerbt von Object)
ToString()

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

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

_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.

(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.Retrieves the type information for an object, which can be used to get the type information for an interface.

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

(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.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch