DescriptionAttribute 類別

定義

命名空間:

System.ComponentModel

組件:

System.ComponentModel.Primitives.dll

來源:

DescriptionAttribute.cs

指定屬性或事件的描述。

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

繼承

Object

Attribute

DescriptionAttribute

衍生

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

屬性

AttributeUsageAttribute

範例

下列範例會 MyImage 建立 屬性。 屬性有兩個CategoryAttribute屬性：和 DescriptionAttribute 。

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

下一個範例會取得的描述 MyImage。 首先，程式代碼會取得 PropertyDescriptorCollection 具有物件之所有屬性的 。 接下來，它會編制索引到 PropertyDescriptorCollection ，以取得 MyImage。 然後它會傳回此屬性的屬性，並將其儲存在屬性變數中。

然後，此範例會從 AttributeCollection擷取 DescriptionAttribute 來列印描述，並將它寫入控制台畫面。

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

備註

可視化設計工具可以在參考元件成員時顯示指定的描述，例如在 屬性視窗 中。 呼叫 Description 以存取此屬性的值。

如需詳細資訊，請參閱屬性。

建構函式

DescriptionAttribute()	使用無參數的方式，初始化 DescriptionAttribute 類別的新執行個體。
DescriptionAttribute(String)	使用描述來初始化 DescriptionAttribute 類別的新執行個體。

欄位

Default

指定 DescriptionAttribute 的預設值，也就是空字串 ("")。 這個 static 欄位是唯讀的。

屬性

Description	取得儲存在這個屬性中的描述。
DescriptionValue	取得或設定儲存為描述的字串。
TypeId	在衍生類別中實作時，取得這個 Attribute 的唯一識別碼。 (繼承來源 Attribute)

方法

Equals(Object)	傳回值，表示指定的物件值是否等於目前的 DescriptionAttribute。
GetHashCode()	傳回這個執行個體的雜湊碼。
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
IsDefaultAttribute()	傳回數值，表示此項目是否為預設的 DescriptionAttribute 執行個體。
Match(Object)	在衍生類別中覆寫時，會傳回值，表示這個執行個體是否等於指定物件。 (繼承來源 Attribute)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)

另請參閱

• Attribute
• PropertyDescriptor
• EventDescriptor