DescriptionAttribute 클래스

정의

네임스페이스:

System.ComponentModel

어셈블리:

System.ComponentModel.Primitives.dll

Source:

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 . 속성에는 및 의 두 가지 특성이 DescriptionAttribute 있습니다 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대한 설명을 가져옵니다. 먼저 코드를 가져옵니다는 PropertyDescriptorCollection 개체에 대 한 모든 속성을 사용 하 여 합니다. 다음으로 인덱스는 PropertyDescriptorCollection 가져오려고 MyImage합니다. 그런 다음이 속성에 대 한 특성을 반환 하 고 특성 변수에 저장 합니다.

그런 다음, 에서 를 검색하고 DescriptionAttributeAttributeCollection콘솔 화면에 작성하여 설명을 인쇄합니다.

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