DescriptionAttribute 클래스
속성 또는 이벤트에 대한 설명을 지정합니다.
네임스페이스: System.ComponentModel
어셈블리: System(system.dll)
구문
‘선언
<AttributeUsageAttribute(AttributeTargets.All)> _
Public Class DescriptionAttribute
Inherits Attribute
‘사용 방법
Dim instance As DescriptionAttribute
[AttributeUsageAttribute(AttributeTargets.All)]
public class DescriptionAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::All)]
public ref class DescriptionAttribute : public Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.All) */
public class DescriptionAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.All)
public class DescriptionAttribute extends Attribute
설명
비주얼 디자이너는 속성 창 등에서 구성 요소 멤버를 참조할 때 지정된 설명을 표시할 수 있습니다. 이 특성의 값에 액세스하려면 Description을 호출합니다.
자세한 내용은 특성 개요 및 특성을 사용하여 메타데이터 확장을 참조하십시오.
예제
다음 예제에서는 MyImage 속성을 만듭니다. 이 속성에는 DescriptionAttribute 및 CategoryAttribute의 두 가지 특성이 있습니다.
<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
[Description("The image associated with the control"),Category("Appearance")]
public Image MyImage {
get {
// Insert code here.
return image1;
}
set {
// Insert code here.
}
}
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.
}
}
/** @attribute Description("The image associated with the control")
@attribute Category("Appearance")
*/
/** @property
*/
public Image get_MyImage()
{
// Insert code here.
return image1;
} //get_MyImage
/** @property
*/
public void set_MyImage(Image value)
{
// Insert code here.
} //set_MyImage
다음 예제에서는 MyImage의 설명을 가져옵니다. 먼저 코드는 개체의 모든 속성이 들어 있는 PropertyDescriptorCollection을 가져옵니다. 다음에는 PropertyDescriptorCollection으로 인덱싱하여 MyImage를 가져옵니다. 그런 다음 이 속성의 특성을 반환하여 특성 변수에 저장합니다.
이 예제에서는 AttributeCollection에서 DescriptionAttribute를 검색한 다음 이를 콘솔 화면에 쓰는 방법으로 설명을 출력합니다.
' 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)
// 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.
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).
get_Item("MyImage").get_Attributes();
/* Prints the description by retrieving the DescriptionAttribute
from the AttributeCollection.
*/
DescriptionAttribute myAttribute = (DescriptionAttribute)(attributes.
get_Item(DescriptionAttribute.class.ToType()));
Console.WriteLine(myAttribute.get_Description());
상속 계층 구조
System.Object
System.Attribute
System.ComponentModel.DescriptionAttribute
파생 클래스
스레드로부터의 안전성
이 형식의 모든 public static(Visual Basic의 경우 Shared) 멤버는 스레드로부터 안전합니다. 인터페이스 멤버는 스레드로부터 안전하지 않습니다.
플랫폼
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
.NET Framework에서 모든 플래폼의 모든 버전을 지원하지는 않습니다. 지원되는 버전의 목록은 시스템 요구 사항을 참조하십시오.
버전 정보
.NET Framework
2.0, 1.1, 1.0에서 지원
참고 항목
참조
DescriptionAttribute 멤버
System.ComponentModel 네임스페이스
Attribute
PropertyDescriptor
EventDescriptor