DescriptionAttribute Klasse

Definition

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

Mehr …

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.

Weitere Informationen

• Attribute
• PropertyDescriptor
• EventDescriptor