DescriptionAttribute クラス

定義

プロパティまたはイベントの説明文を指定します。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
継承
DescriptionAttribute
派生
属性

次の例では、MyImage プロパティを作成します。The following example creates the MyImage property. プロパティには、DescriptionAttributeCategoryAttributeの2つの属性があります。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. 次に、MyImageを取得するために PropertyDescriptorCollection にインデックスを付けます。Next 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)

指定したオブジェクトの値が現在の DescriptionAttribute と等しいかどうかを示す値を返します。Returns whether the value of the given object is equal to the current DescriptionAttribute.

GetHashCode()

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

GetType()

現在のインスタンスの Type を取得します。Gets 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()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

明示的なインターフェイスの実装

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

一連の名前を対応する一連のディスパッチ識別子に割り当てます。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)

適用対象

こちらもご覧ください