DescriptionAttribute 類別

定義

指定屬性或事件的描述。Specifies a description for a property or event.

public ref class DescriptionAttribute : Attribute
public class DescriptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attribute
type DescriptionAttribute = class
    inherit Attribute
Public Class DescriptionAttribute
Inherits Attribute
繼承
DescriptionAttribute
衍生
屬性

範例

下列範例會建立 MyImage 屬性。The following example creates the MyImage property. 屬性有兩個屬性: DescriptionAttributeCategoryAttributeThe 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

下一個範例會取得 MyImage的描述。The next example gets the description of MyImage. 首先,程式碼會取得 PropertyDescriptorCollection,其中包含物件的所有屬性。First the code gets a PropertyDescriptorCollection with all the properties for the object. 接著,它會在 PropertyDescriptorCollection 中編制索引,以取得 MyImageNext it indexes into the PropertyDescriptorCollection to get MyImage. 然後,它會傳回這個屬性的屬性,並將其儲存在 attributes 變數中。Then it returns the attributes for this property and saves them in the attributes variable.

然後,此範例會從 AttributeCollection抓取 DescriptionAttribute,並將其寫入主控台畫面,以列印描述。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)

備註

視覺化設計工具可以在參考元件成員時顯示指定的描述,例如在屬性視窗中。A visual designer can display the specified description when referencing the component member, such as in a Properties window. 呼叫 Description 以存取此屬性的值。Call Description to access the value of this attribute.

如需詳細資訊,請參閱屬性For more information, see Attributes.

建構函式

DescriptionAttribute()

使用無參數的方式,初始化 DescriptionAttribute 類別的新執行個體。Initializes a new instance of the DescriptionAttribute class with no parameters.

DescriptionAttribute(String)

使用描述來初始化 DescriptionAttribute 類別的新執行個體。Initializes a new instance of the DescriptionAttribute class with a description.

欄位

Default

指定 DescriptionAttribute 的預設值,也就是空字串 ("")。Specifies the default value for the DescriptionAttribute, which is an empty string (""). 這個 static 欄位是唯讀的。This static field is read-only.

屬性

Description

取得儲存在這個屬性中的描述。Gets the description stored in this attribute.

DescriptionValue

取得或設定儲存為描述的字串。Gets or sets the string stored as the description.

TypeId

在衍生類別中實作時,取得這個 Attribute 的唯一識別碼。When implemented in a derived class, gets a unique identifier for this Attribute.

(繼承來源 Attribute)

方法

Equals(Object)

傳回值,表示指定的物件值是否等於目前的 DescriptionAttributeReturns whether the value of the given object is equal to the current DescriptionAttribute.

GetHashCode()

傳回這個執行個體的雜湊碼。Returns the hash code for this instance.

GetType()

取得目前執行個體的 TypeGets the Type of the current instance.

(繼承來源 Object)
IsDefaultAttribute()

傳回數值,表示此項目是否為預設的 DescriptionAttribute 執行個體。Returns a value indicating whether this is the default DescriptionAttribute instance.

Match(Object)

在衍生類別中覆寫時,會傳回值,表示這個執行個體是否等於指定物件。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(繼承來源 Attribute)
MemberwiseClone()

建立目前 Object 的淺層複製。Creates a shallow copy of the current Object.

(繼承來源 Object)
ToString()

傳回代表目前物件的字串。Returns a string that represents the current object.

(繼承來源 Object)

明確介面實作

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

將一組名稱對應至一組對應的分派識別項 (Dispatch Identifier)。Maps a set of names to a corresponding set of dispatch identifiers.

(繼承來源 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

擷取物件的類型資訊,可以用來取得介面的類型資訊。Retrieves the type information for an object, which can be used to get the type information for an interface.

(繼承來源 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

擷取物件提供的類型資訊介面數目 (0 或 1)。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(繼承來源 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

提供物件所公開的屬性和方法的存取權。Provides access to properties and methods exposed by an object.

(繼承來源 Attribute)

適用於

另請參閱