DescriptionAttribute Kelas

Definisi

Ruang nama:

System.ComponentModel

Rakitan:

System.ComponentModel.Primitives.dll

Sumber:

DescriptionAttribute.cs

Menentukan deskripsi untuk properti atau peristiwa.

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

Warisan

Object

Attribute

DescriptionAttribute

Turunan

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

Atribut

AttributeUsageAttribute

Contoh

Contoh berikut membuat MyImage properti . Properti memiliki dua atribut, a DescriptionAttribute dan 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

Contoh berikutnya mendapatkan deskripsi .MyImage Pertama kode mendapatkan PropertyDescriptorCollection dengan semua properti untuk objek . Selanjutnya diindeks ke PropertyDescriptorCollection dalam untuk mendapatkan MyImage. Kemudian mengembalikan atribut untuk properti ini dan menyimpannya dalam variabel atribut.

Contoh kemudian mencetak deskripsi dengan mengambil DescriptionAttribute dari AttributeCollection, dan menulisnya ke layar konsol.

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

Keterangan

Perancang visual dapat menampilkan deskripsi yang ditentukan saat merujuk anggota komponen, seperti di jendela Properti. Panggil Description untuk mengakses nilai atribut ini.

Untuk informasi selengkapnya, lihat Atribut.

Konstruktor

DescriptionAttribute()	Menginisialisasi instans DescriptionAttribute baru kelas tanpa parameter.
DescriptionAttribute(String)	Menginisialisasi instans DescriptionAttribute baru kelas dengan deskripsi.

Bidang

Default

Menentukan nilai default untuk DescriptionAttribute, yang merupakan string kosong (""). Bidang ini static bersifat baca-saja.

Properti

Description	Mendapatkan deskripsi yang disimpan dalam atribut ini.
DescriptionValue	Mendapatkan atau mengatur string yang disimpan sebagai deskripsi.
TypeId	Ketika diimplementasikan di kelas turunan, mendapatkan pengidentifikasi unik untuk ini Attribute. (Diperoleh dari Attribute)

Metode

Equals(Object)	Mengembalikan apakah nilai objek yang diberikan sama dengan saat ini DescriptionAttribute.
GetHashCode()	Mengembalikan kode hash untuk instans ini.
GetType()	Mendapatkan dari instans Type saat ini. (Diperoleh dari Object)
IsDefaultAttribute()	Mengembalikan nilai yang menunjukkan apakah ini adalah instans default DescriptionAttribute .
Match(Object)	Saat ditimpa di kelas turunan, mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Lihat juga

• Attribute
• PropertyDescriptor
• EventDescriptor