DescriptionAttribute Klasse

Definition

Namespace:
System.ComponentModel
Assembly:
System.dll
Assembly:
netstandard.dll

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
Attribute
AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird die MyImage Eigenschaft erstellt. Die Eigenschaft verfügt über zwei Attribute, a DescriptionAttribute und 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.
        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. Zuerst ruft der Code eine PropertyDescriptorCollection mit allen Eigenschaften für das Objekt ab. Als Nächstes wird es indiziert PropertyDescriptorCollection , um abzurufen MyImage. Anschließend werden die Attribute für diese Eigenschaft zurückgegeben und in der Attributvariable gespeichert.

Anschließend wird 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 anzeigen, wenn auf das Komponentenelement verwiesen wird, z. B. in einer Eigenschaftenfenster. Aufrufen Description , um auf den Wert dieses Attributs zuzugreifen.

Weitere Informationen finden Sie unter Attribute.

Konstruktoren

Name Beschreibung
DescriptionAttribute()

Initialisiert eine neue Instanz der DescriptionAttribute Klasse ohne Parameter.
DescriptionAttribute(String)

Initialisiert eine neue Instanz der DescriptionAttribute Klasse mit einer Beschreibung.

Felder

Name Beschreibung
Default

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

Eigenschaften

Name Beschreibung
Description

Ruft die in diesem Attribut gespeicherte Beschreibung ab.
DescriptionValue

Ruft die als Beschreibung gespeicherte Zeichenfolge ab oder legt sie fest.
TypeId

Wenn sie in einer abgeleiteten Klasse implementiert wird, wird ein eindeutiger Bezeichner für diese Attribute.

(Geerbt von Attribute)

Methoden

Name Beschreibung
Equals(Object)

Gibt zurück, ob der Wert des angegebenen Objekts dem aktuellen DescriptionAttributeentspricht.
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.
GetType()

Ruft die Type der aktuellen Instanz ab.

(Geerbt von Object)
IsDefaultAttribute()

Gibt einen Wert zurück, der angibt, ob dies die Standardinstanz DescriptionAttribute ist.
IsDefaultAttribute()

Wenn sie in einer abgeleiteten Klasse überschrieben wird, gibt an, ob der Wert dieser Instanz der Standardwert für die abgeleitete Klasse ist.

(Geerbt von Attribute)
Match(Object)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem angegebenen Objekt entspricht.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie der aktuellen Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

Name Beschreibung
_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 denen 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)

Bietet Zugriff auf Eigenschaften und Methoden, die von einem Objekt verfügbar gemacht werden.

(Geerbt von Attribute)

Gilt für:

Weitere Informationen