DesignOnlyAttribute

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

DesignOnlyAttribute クラス

プロパティを設定できるのがデザイン時だけかどうかを指定します。

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As DesignOnlyAttribute

C#

[AttributeUsageAttribute(AttributeTargets.All)] 
public sealed class DesignOnlyAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::All)] 
public ref class DesignOnlyAttribute sealed
 : public Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.All) */ 
public final class DesignOnlyAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.All) 
public final class DesignOnlyAttribute extends
 Attribute

解説

DesignOnlyAttribute に true を設定してマークされているメンバは、デザイン時にだけ設定できます。通常、これらのプロパティはデザイン時しか存在せず、実行時にオブジェクト上に存在するプロパティには対応しません。

属性を持たないメンバ、または DesignOnlyAttribute を false に設定してマークされているメンバは、実行時に設定できます。既定値は false です。

DesignOnlyAttribute が true に設定されているプロパティは、値が InitializeComponent メソッドではなく .resx ファイルにシリアル化されます。

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

使用例

GetLanguage プロパティを作成する例を次に示します。このプロパティは、DesignOnlyAttribute でマークされます。

Visual Basic

<DesignOnly(True)> _
Public Property GetLanguage() As
 CultureInfo
    Get
        ' Insert code here.
        Return myCultureInfo
    End Get
    Set
        ' Insert code here.
    End Set
End Property

C#

[DesignOnly(true)]
 public CultureInfo GetLanguage {
    get {
       // Insert code here.
       return myCultureInfo;
    }
    set {
       // Insert code here.
    }
 }

C++

public:
   [DesignOnly(true)]
   property CultureInfo^ GetLanguage 
   {
      CultureInfo^ get()
      {
         // Insert code here.
         return myCultureInfo;
      }
      void set( CultureInfo^ value )
      {
         // Insert code here.
      }
   }

J#

/** @attribute DesignOnly(true)
 */
/** @property 
 */
public CultureInfo get_GetLanguage()
{
    // Insert code here.
    return myCultureInfo;
} //get_GetLanguage

/** @property 
 */
public void set_GetLanguage(CultureInfo value)
{
    // Insert code here.
} //set_GetLanguage

DesignOnlyAttribute の値を取得する例を次に示します。最初に、オブジェクトのすべてのプロパティを保持する PropertyDescriptorCollection を取得します。次に、インデックスを付けて PropertyDescriptorCollection から GetLanguage プロパティを検索します。そして、このプロパティの属性を返し、その属性を属性変数に保存します。

最後に、AttributeCollection から DesignOnlyAttribute を取得し、取得した情報をコンソール画面に書き込むことによって、プロパティを設定できるのがデザイン時だけかどうかを出力します。

Visual Basic

' Gets the attributes for the property.
Dim attributes As AttributeCollection = _
    TypeDescriptor.GetProperties(Me)("GetLanguage").Attributes

' Prints the description by retrieving the DescriptionAttribute
' from the AttributeCollection. 
Dim myAttribute As DesignOnlyAttribute = _
    CType(attributes(GetType(DesignOnlyAttribute)), DesignOnlyAttribute)
Console.WriteLine(("This property is design only :"
 & _
    myAttribute.IsDesignOnly.ToString()))

C#

// Gets the attributes for the property.
 AttributeCollection attributes = 
    TypeDescriptor.GetProperties(this)["GetLanguage"].Attributes;
 
 /* Prints the description by retrieving the DescriptionAttribute 
  * from the AttributeCollection. */
 DesignOnlyAttribute myAttribute = 
    (DesignOnlyAttribute)attributes[typeof(DesignOnlyAttribute)];
 Console.WriteLine("This property is design only :" +
    myAttribute.IsDesignOnly.ToString());

C++

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this
 )[ "GetLanguage" ]->Attributes;

/* Prints the description by retrieving the DescriptionAttribute 
       * from the AttributeCollection. */
DesignOnlyAttribute^ myAttribute = dynamic_cast<DesignOnlyAttribute^>(attributes[
 DesignOnlyAttribute::typeid ]);
Console::WriteLine( "This property is design only :{0}", myAttribute->IsDesignOnly
 );

J#

// Gets the attributes for the property.
AttributeCollection attributes = TypeDescriptor.GetProperties(this).
    get_Item("GetLanguage").get_Attributes();

/* Prints the description by retrieving the DescriptionAttribute 
   from the AttributeCollection. 
 */
DesignOnlyAttribute myAttribute = (DesignOnlyAttribute)(attributes.
    get_Item(DesignOnlyAttribute.class.ToType()));

Console.WriteLine("This property is design only :" 
    + System.Convert.ToString(myAttribute.get_IsDesignOnly()));

継承階層

System.Object
   System.Attribute
    System.ComponentModel.DesignOnlyAttribute

スレッド セーフ

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

参照

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

DesignOnlyAttribute コンストラクタ

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

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

Visual Basic (宣言)

Public Sub New ( _
    isDesignOnly As Boolean _
)

Visual Basic (使用法)

Dim isDesignOnly As Boolean

Dim instance As New DesignOnlyAttribute(isDesignOnly)

C#

public DesignOnlyAttribute (
    bool isDesignOnly
)

C++

public:
DesignOnlyAttribute (
    bool isDesignOnly
)

J#

public DesignOnlyAttribute (
    boolean isDesignOnly
)

JScript

public function DesignOnlyAttribute (
    isDesignOnly : boolean
)

パラメータ

isDesignOnly

プロパティを設定できるのがデザイン時だけの場合は true。プロパティをデザイン時と実行時の両方で設定できる場合は false。

プラットフォーム

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

参照

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

DesignOnlyAttribute フィールド

パブリック フィールド

	名前	説明
	Default	DesignOnlyAttribute の既定値 (No) を指定します。static フィールドは読み取り専用です。
	No	プロパティをデザイン時に設定できるか、または実行時に設定できるかを指定します。static フィールドは読み取り専用です。
	Yes	プロパティを設定できるのがデザイン時だけであることを指定します。static フィールドは読み取り専用です。

参照

関連項目

DesignOnlyAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor

DesignOnlyAttribute プロパティ

パブリック プロパティ

	名前	説明
	IsDesignOnly	プロパティを設定できるのがデザイン時だけかどうかを示す値を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

関連項目

DesignOnlyAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor

DesignOnlyAttribute メソッド

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

DesignOnlyAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor

DesignOnlyAttribute メンバ

プロパティを設定できるのがデザイン時だけかどうかを指定します。

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

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

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

パブリック フィールド

	名前	説明
	Default	DesignOnlyAttribute の既定値 (No) を指定します。static フィールドは読み取り専用です。
	No	プロパティをデザイン時に設定できるか、または実行時に設定できるかを指定します。static フィールドは読み取り専用です。
	Yes	プロパティを設定できるのがデザイン時だけであることを指定します。static フィールドは読み取り専用です。

パブリック プロパティ

	名前	説明
	IsDesignOnly	プロパティを設定できるのがデザイン時だけかどうかを示す値を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

DesignOnlyAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor