DefaultPropertyAttribute

.NET Framework クラス ライブラリ リファレンス

DefaultPropertyAttribute クラス

コンポーネントの既定のプロパティを指定します。

名前空間: System.ComponentModel
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Class)> _
Public NotInheritable Class
 DefaultPropertyAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As DefaultPropertyAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Class)] 
public sealed class DefaultPropertyAttribute
 : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Class)] 
public ref class DefaultPropertyAttribute sealed
 : public Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Class) */ 
public final class DefaultPropertyAttribute
 extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Class) 
public final class DefaultPropertyAttribute
 extends Attribute

解説

既定のプロパティの名前を取得するには、Name プロパティを使用します。

詳細については、属性の概要、属性を使用したメタデータの拡張 の各トピックを参照してください。

Topic	Location
チュートリアル : カスタム サーバー コントロールの開発と使用	ASP.NET コントロールの作成

使用例

MyControl という名前のコントロールを定義する例を次に示します。このクラスは、既定のプロパティとして MyProperty を指定する DefaultPropertyAttribute を使用してマークされます。

Visual Basic

<DefaultProperty("MyProperty")> _
Public Class MyControl
    Inherits Control

    Public Property MyProperty() As
 Integer
        Get
            ' Insert code here.
            Return 0
        End Get
        Set
            ' Insert code here.
        End Set 
    End Property
    ' Insert any additional code.
End Class 'MyControl

C#

[DefaultProperty("MyProperty")]
 public class MyControl : Control {
 
    public int MyProperty {
       get {
          // Insert code here.
          return 0;
       }
       set {
          // Insert code here.
       }
    }
 
    // Insert any additional code.
 
 }

C++

[DefaultProperty("MyProperty")]
ref class MyControl: public Control
{
public:

   property int MyProperty 
   {
      int get()
      {
         // Insert code here.
         return 0;
      }

      void set( int value
 )
      {
         // Insert code here.
      }
   }
   // Insert any additional code.
};

J#

/** @attribute DefaultProperty("MyProperty")
 */
public static class MyControl
 extends Control
{
    /** @property 
     */
    public int get_MyProperty()
    {
        // Insert code here.
        return 0;
    } //get_MyProperty

    /** @property 
     */
    public void set_MyProperty(int
 value)
    {
        // Insert code here.
    } //set_MyProperty

    // Insert any additional code.

} //MyControl

MyControl のインスタンスを作成する例を次に示します。そのクラスの属性を取得し、DefaultPropertyAttribute を抽出してから、既定のプロパティの名前を出力します。

Visual Basic

Public Shared Function Main()
 As Integer
    ' Creates a new control.
    Dim myNewControl As New
 MyControl()
    
    ' Gets the attributes for the collection.
    Dim attributes As AttributeCollection =
 TypeDescriptor.GetAttributes(myNewControl)
    
    ' Prints the name of the default property by retrieving the
    ' DefaultPropertyAttribute from the AttributeCollection. 
    Dim myAttribute As DefaultPropertyAttribute
 = _
        CType(attributes(GetType(DefaultPropertyAttribute)), DefaultPropertyAttribute)
    Console.WriteLine(("The default property is: "
 + myAttribute.Name))
    Return 0
End Function 'Main

C#

public static int Main()
 {
    // Creates a new control.
    MyControl myNewControl = new MyControl();
 
    // Gets the attributes for the collection.
    AttributeCollection attributes = TypeDescriptor.GetAttributes(myNewControl);
 
    /* Prints the name of the default property by retrieving the
 
     * DefaultPropertyAttribute from the AttributeCollection. */
    DefaultPropertyAttribute myAttribute = 
       (DefaultPropertyAttribute)attributes[typeof(DefaultPropertyAttribute)];
    Console.WriteLine("The default property is: " +
 myAttribute.Name);
  
    return 0;
 }

C++

int main()
{
   // Creates a new control.
   Form1::MyControl^ myNewControl = gcnew Form1::MyControl;

   // Gets the attributes for the collection.
   AttributeCollection^ attributes = TypeDescriptor::GetAttributes( myNewControl
 );

   /* Prints the name of the default property by retrieving the
 
       * DefaultPropertyAttribute from the AttributeCollection. */
   DefaultPropertyAttribute^ myAttribute = dynamic_cast<DefaultPropertyAttribute^>(attributes[
 DefaultPropertyAttribute::typeid ]);
   Console::WriteLine( "The default property is: {0}",
 myAttribute->Name );
   return 0;
}

J#

public static void main(String[]
 args)
{
    // Creates a new control.        
    MyControl myNewControl = new MyControl();

    // Gets the attributes for the collection.
    AttributeCollection attributes = 
        TypeDescriptor.GetAttributes(myNewControl);

    /* Prints the name of the default property by retrieving the
 
       DefaultPropertyAttribute from the AttributeCollection. 
     */
    DefaultPropertyAttribute myAttribute = 
        (DefaultPropertyAttribute)(attributes.get_Item(
        DefaultPropertyAttribute.class.ToType()));

    Console.WriteLine("The default property is: " 
        + myAttribute.get_Name());
    
} //main

継承階層

System.Object
   System.Attribute
    System.ComponentModel.DefaultPropertyAttribute

スレッド セーフ

この型の 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

参照

関連項目
DefaultPropertyAttribute メンバ
System.ComponentModel 名前空間
Attribute

DefaultPropertyAttribute コンストラクタ

DefaultPropertyAttribute クラスの新しいインスタンスを初期化します。

名前空間: System.ComponentModel
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    name As String _
)

Visual Basic (使用法)

Dim name As String

Dim instance As New DefaultPropertyAttribute(name)

C#

public DefaultPropertyAttribute (
    string name
)

C++

public:
DefaultPropertyAttribute (
    String^ name
)

J#

public DefaultPropertyAttribute (
    String name
)

JScript

public function DefaultPropertyAttribute (
    name : String
)

パラメータ

name

この属性が関連付けられているコンポーネントの既定のプロパティ名。

プラットフォーム

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

参照

関連項目
DefaultPropertyAttribute クラス
DefaultPropertyAttribute メンバ
System.ComponentModel 名前空間

DefaultPropertyAttribute フィールド

パブリック フィールド

	名前	説明
	Default	DefaultPropertyAttribute の既定値 (null 参照 (Visual Basic では Nothing)) を指定します。static フィールドは読み取り専用です。

参照

関連項目

DefaultPropertyAttribute クラス
System.ComponentModel 名前空間
Attribute

DefaultPropertyAttribute プロパティ

パブリック プロパティ

	名前	説明
	Name	この属性が関連付けられているコンポーネントの既定のプロパティ名を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

関連項目

DefaultPropertyAttribute クラス
System.ComponentModel 名前空間
Attribute

DefaultPropertyAttribute メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。 指定したオブジェクトの値が現在の DefaultPropertyAttribute と等しいかどうかを示す値を返します。
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	オーバーライドされます。 対象のインスタンスのハッシュ コードを返します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 ( Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

DefaultPropertyAttribute クラス
System.ComponentModel 名前空間
Attribute

DefaultPropertyAttribute メンバ

コンポーネントの既定のプロパティを指定します。

DefaultPropertyAttribute データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	DefaultPropertyAttribute	DefaultPropertyAttribute クラスの新しいインスタンスを初期化します。

パブリック フィールド

	名前	説明
	Default	DefaultPropertyAttribute の既定値 (null 参照 (Visual Basic では Nothing)) を指定します。static フィールドは読み取り専用です。

パブリック プロパティ

	名前	説明
	Name	この属性が関連付けられているコンポーネントの既定のプロパティ名を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。 指定したオブジェクトの値が現在の DefaultPropertyAttribute と等しいかどうかを示す値を返します。
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	オーバーライドされます。 対象のインスタンスのハッシュ コードを返します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 (Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

DefaultPropertyAttribute クラス
System.ComponentModel 名前空間
Attribute