DescriptionAttribute Sınıf

Tanım

Ad Alanı:

System.ComponentModel

Bütünleştirilmiş Kod:

System.ComponentModel.Primitives.dll

Kaynak:

DescriptionAttribute.cs

Bir özellik veya olay için açıklama belirtir.

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

Devralma

Object

Attribute

DescriptionAttribute

Türetilmiş

Microsoft.VisualBasic.Compatibility.VB6.SRDescriptionAttribute

System.Data.DataSysDescriptionAttribute

System.Diagnostics.MonitoringDescriptionAttribute

System.DirectoryServices.DSDescriptionAttribute

System.IO.IODescriptionAttribute

System.Messaging.MessagingDescriptionAttribute

System.ServiceProcess.ServiceProcessDescriptionAttribute

System.Timers.TimersDescriptionAttribute

Öznitelikler

AttributeUsageAttribute

Örnekler

Aşağıdaki örnek özelliğini oluşturur MyImage . özelliğinin iki özniteliği vardır: a DescriptionAttribute ve 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

Sonraki örnek açıklamasını MyImagealır. İlk olarak kod, nesnenin tüm özelliklerini içeren bir PropertyDescriptorCollection alır. Ardından almak için dizinini PropertyDescriptorCollection oluşturur MyImage. Ardından bu özelliğin özniteliklerini döndürür ve öznitelikler değişkenine kaydeder.

Örnek daha sonra , içinden alıp DescriptionAttributeAttributeCollectionkonsol ekranına yazarak açıklamayı yazdırır.

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

Açıklamalar

Görsel tasarımcı, bir Özellikler penceresi gibi bileşen üyesine başvururken belirtilen açıklamayı görüntüleyebilir. Bu özniteliğin değerine erişmek için çağrısı Description .

Daha fazla bilgi için bkz . Öznitelikler.

Oluşturucular

DescriptionAttribute()	Parametresiz olarak sınıfının yeni bir örneğini DescriptionAttribute başlatır.
DescriptionAttribute(String)	Sınıfın DescriptionAttribute yeni bir örneğini bir açıklamayla başlatır.

Alanlar

Default

için DescriptionAttributeboş dize ("") olan varsayılan değeri belirtir. Bu static alan salt okunur.

Özellikler

Description	Bu öznitelikte depolanan açıklamayı alır.
DescriptionValue	Açıklama olarak depolanan dizeyi alır veya ayarlar.
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)

Yöntemler

Equals(Object)	Verilen nesnenin değerinin geçerli DescriptionAttributedeğerine eşit olup olmadığını döndürür.
GetHashCode()	Bu örneğe ilişkin karma kodu döndürür.
GetType()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Bunun varsayılan DescriptionAttribute örnek olup olmadığını belirten bir değer döndürür.
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden dizeyi döndürür. (Devralındığı yer: Object)

Ayrıca bkz.

• Attribute
• PropertyDescriptor
• EventDescriptor