DescriptionAttribute Klasa

Definicja

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

Dziedziczenie

Object

Attribute

DescriptionAttribute

Pochodne

Microsoft.VisualBasic.Compatibility.VB6.SRDescriptionAttribute

System.Data.DataSysDescriptionAttribute

System.Diagnostics.MonitoringDescriptionAttribute

System.DirectoryServices.DSDescriptionAttribute

System.IO.IODescriptionAttribute

Więcej…

Atrybuty

AttributeUsageAttribute

Przykłady

Poniższy przykład tworzy MyImage Właściwość.The following example creates the MyImage property. Właściwość ma dwa atrybuty, DescriptionAttribute a i 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

Następny przykład Pobiera opis MyImage .The next example gets the description of MyImage. Pierwszy kod pobiera PropertyDescriptorCollection wszystkie właściwości obiektu.First the code gets a PropertyDescriptorCollection with all the properties for the object. Następnie indeksuje element PropertyDescriptorCollection do get MyImage .Next it indexes into the PropertyDescriptorCollection to get MyImage. Następnie zwraca atrybuty dla tej właściwości i zapisuje je w zmiennej atrybutów.Then it returns the attributes for this property and saves them in the attributes variable.

Następnie w przykładzie jest drukowany opis przez pobranie DescriptionAttribute z AttributeCollection i zapisanie go na ekranie konsoli.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)

Uwagi

Projektant wizualny może wyświetlić określony opis podczas odwoływania się do elementu członkowskiego składnika, takiego jak w okno Właściwości.A visual designer can display the specified description when referencing the component member, such as in a Properties window. Wywołaj Description , aby uzyskać dostęp do wartości tego atrybutu.Call Description to access the value of this attribute.

Aby uzyskać więcej informacji, zobacz atrybuty.For more information, see Attributes.

Konstruktory

Pola

Właściwości

Metody

Jawne implementacje interfejsu

Dotyczy

Zobacz też

• Attribute
• PropertyDescriptor
• EventDescriptor