DescriptionAttribute DescriptionAttribute DescriptionAttribute DescriptionAttribute Class

정의

속성 또는 이벤트에 대한 설명을 지정합니다.Specifies a description for a property or event.

public ref class DescriptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attribute
type DescriptionAttribute = class
    inherit Attribute
Public Class DescriptionAttribute
Inherits Attribute
상속
DescriptionAttributeDescriptionAttributeDescriptionAttributeDescriptionAttribute
파생
특성

예제

다음 예제에서는 MyImage 속성입니다.The following example creates the MyImage property. 속성에는 두 가지 특성을 DescriptionAttributeCategoryAttribute합니다.The 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 가져오려고 MyImage합니다.Next it indexes into the PropertyDescriptorCollection to get MyImage. 그런 다음이 속성에 대 한 특성을 반환 하 고 특성 변수에 저장 합니다.Then it returns the attributes for this property and saves them in the attributes variable.

이 예제에서는 다음 출력 설명을 검색 하 여 DescriptionAttribute 에서 AttributeCollection, 콘솔 화면에 쓰는 합니다.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() DescriptionAttribute() DescriptionAttribute()

매개 변수를 사용하지 않고 DescriptionAttribute 클래스의 새 인스턴스를 초기화합니다.Initializes a new instance of the DescriptionAttribute class with no parameters.

DescriptionAttribute(String) DescriptionAttribute(String) DescriptionAttribute(String) DescriptionAttribute(String)

설명을 사용하여 DescriptionAttribute 클래스의 새 인스턴스를 초기화합니다.Initializes a new instance of the DescriptionAttribute class with a description.

필드

Default Default Default Default

DescriptionAttribute의 기본값인 빈 문자열("")을 지정합니다.Specifies the default value for the DescriptionAttribute, which is an empty string (""). static 필드는 읽기 전용입니다.This static field is read-only.

속성

Description Description Description Description

이 특성에 저장된 설명을 가져옵니다.Gets the description stored in this attribute.

DescriptionValue DescriptionValue DescriptionValue DescriptionValue

설명으로 저장된 문자열을 가져오거나 설정합니다.Gets or sets the string stored as the description.

TypeId TypeId TypeId TypeId

파생 클래스에서 구현된 경우 이 Attribute에 대한 고유 식별자를 가져옵니다.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

메서드

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

주어진 개체의 값이 현재 DescriptionAttribute와 같은지 여부를 반환합니다.Returns whether the value of the given object is equal to the current DescriptionAttribute.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

이 인스턴스의 해시 코드를 반환합니다.Returns the hash code for this instance.

GetType() GetType() GetType() GetType()

현재 인스턴스의 Type을 가져옵니다.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

이것이 기본 DescriptionAttribute 인스턴스인지 여부를 나타내는 값을 반환합니다.Returns a value indicating whether this is the default DescriptionAttribute instance.

Match(Object) Match(Object) Match(Object) Match(Object)

파생 클래스에서 재정의된 경우 이 인스턴스가 지정된 개체와 같은지 여부를 나타내는 값을 반환합니다.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

현재 Object의 단순 복사본을 만듭니다.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

현재 개체를 나타내는 문자열을 반환합니다.Returns a string that represents the current object.

(Inherited from Object)

명시적 인터페이스 구현

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

이름 집합을 해당하는 디스패치 식별자 집합에 매핑합니다.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

인터페이스의 형식 정보를 가져오는 데 사용할 수 있는 개체의 형식 정보를 검색합니다.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

개체에서 제공하는 형식 정보 인터페이스의 수를 검색합니다(0 또는 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

개체에서 노출하는 메서드와 속성에 대한 액세스를 제공합니다.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

적용 대상

추가 정보