RecommendedAsConfigurableAttribute

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

RecommendedAsConfigurableAttribute クラス

メモ : このクラスは、互換性のために残されています。 旧式でない代替が必要な場合は、SettingsBindableAttribute を使用してください。

プロパティをアプリケーションの設定値として使用できることを指定します。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Property)> _
<ObsoleteAttribute("Use System.ComponentModel.SettingsBindableAttribute
 instead to work with the new settings model.")> _
Public Class RecommendedAsConfigurableAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As RecommendedAsConfigurableAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Property)] 
[ObsoleteAttribute("Use System.ComponentModel.SettingsBindableAttribute instead
 to work with the new settings model.")] 
public class RecommendedAsConfigurableAttribute
 : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Property)] 
[ObsoleteAttribute(L"Use System.ComponentModel.SettingsBindableAttribute instead
 to work with the new settings model.")] 
public ref class RecommendedAsConfigurableAttribute
 : public Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ 
/** @attribute ObsoleteAttribute("Use System.ComponentModel.SettingsBindableAttribute
 instead to work with the new settings model.") */ 
public class RecommendedAsConfigurableAttribute
 extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Property) 
ObsoleteAttribute("Use System.ComponentModel.SettingsBindableAttribute instead
 to work with the new settings model.") 
public class RecommendedAsConfigurableAttribute
 extends Attribute

解説

RecommendedAsConfigurableAttribute に true を設定してマークされたプロパティは、[プロパティ] ウィンドウ の ConfigurableProperties の行を展開するときに表示されます。推奨される設定値のないプロパティや、RecommendedAsConfigurableAttribute に false を設定してマークされたプロパティは表示されません。これらのプロパティは、アプリケーションの設定値として使用できません。既定値は false です。

RecommendedAsConfigurableAttribute のないプロパティを Visual Studio .NET の設定値に関連付けるには、[プロパティ] ウィンドウの [設定] の下にある [...] ボタンをクリックし、リストから該当するプロパティを選択します。

メモ
true の RecommendedAsConfigurableAttribute を使用してプロパティをマークすると、この属性の値は定数メンバ Yes に設定されます。RecommendedAsConfigurableAttribute に false を設定してマークされたプロパティの場合、値は No になります。したがって、コード内でこの属性の値を確認する場合は、属性を RecommendedAsConfigurableAttribute.Yes または RecommendedAsConfigurableAttribute.No として指定する必要があります。

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

.

使用例

プロパティをアプリケーションの設定値として使用できるようにマークする例を次に示します。

Visual Basic

<RecommendedAsConfigurable(True)> _
Public Property MyProperty() As
 Integer
    Get
        ' Insert code here.
        Return 0
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

C#

[RecommendedAsConfigurable(true)]
 public int MyProperty {
    get {
       // Insert code here.
       return 0;
    }
    set {
       // Insert code here.
    }
 }

C++

public:
   [RecommendedAsConfigurable(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here.
         return 0;
      }
      void set( int /*value*/
 )
      {
         // Insert code here.
      }
   }

J#

/** @attribute RecommendedAsConfigurable(true)
 */
/** @property
 */
public int get_MyProperty()
{
    // Insert code here.
    return 0;
} //get_MyProperty

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

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

この例では、RecommendedAsConfigurableAttribute の値を確認する 2 種類の方法を示します。2 番目のコード片では、Equals メソッドを呼び出します。最後のコード片では、RecommendedAsConfigurable プロパティを使用して値を確認します。

Visual Basic

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

' Checks to see if the value of the RecommendedAsConfigurableAttribute
 is Yes.
If attributes(GetType(RecommendedAsConfigurableAttribute)).Equals(RecommendedAsConfigurableAttribute.Yes)
 Then
    ' Insert code here.
End If 

' This is another way to see if the property is recommended as configurable.
Dim myAttribute As RecommendedAsConfigurableAttribute
 = _
    CType(attributes(GetType(RecommendedAsConfigurableAttribute)),
 RecommendedAsConfigurableAttribute)
If myAttribute.RecommendedAsConfigurable Then
    ' Insert code here.
End If

C#

// Gets the attributes for the property.
AttributeCollection attributes = 
   TypeDescriptor.GetProperties(this)["MyProperty"].Attributes;
 
// Checks to see if the value of the RecommendedAsConfigurableAttribute
 is Yes.
if(attributes[typeof(RecommendedAsConfigurableAttribute)].Equals(RecommendedAsConfigurableAttribute.Yes))
 {
   // Insert code here.
}
 
// This is another way to see if the property is recommended as configurable.
RecommendedAsConfigurableAttribute myAttribute = 
   (RecommendedAsConfigurableAttribute)attributes[typeof(RecommendedAsConfigurableAttribute)];
if(myAttribute.RecommendedAsConfigurable) {
   // Insert code here.
}

C++

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

// Checks to see if the value of the RecommendedAsConfigurableAttribute
 is Yes.
if ( attributes[ RecommendedAsConfigurableAttribute::typeid ]->Equals(
 RecommendedAsConfigurableAttribute::Yes ) )
{
   // Insert code here.
}

// This is another way to see if the property is recommended as configurable.
RecommendedAsConfigurableAttribute^ myAttribute = dynamic_cast<RecommendedAsConfigurableAttribute^>(attributes[
 RecommendedAsConfigurableAttribute::typeid ]);
if ( myAttribute->RecommendedAsConfigurable )
{
   // Insert code here.
}

J#

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

// Checks to see if the value of the
// RecommendedAsConfigurableAttribute is Yes.
if (attributes.get_Item(RecommendedAsConfigurableAttribute.class.
    ToType()).Equals(RecommendedAsConfigurableAttribute.Yes)) {
    // Insert code here.
}

// This is another way to see if the property is recommended
// as configurable.
RecommendedAsConfigurableAttribute myAttribute =
    ((RecommendedAsConfigurableAttribute)(attributes.get_Item
    (RecommendedAsConfigurableAttribute.class.ToType())));

if (myAttribute.get_RecommendedAsConfigurable()) {
    // Insert code here.
}

RecommendedAsConfigurableAttribute を使用してクラスをマークした場合は、次のコードを使用して値を確認します。

Visual Basic

Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(RecommendedAsConfigurableAttribute)).Equals(RecommendedAsConfigurableAttribute.Yes)
 Then
    ' Insert code here.
End If 

C#

AttributeCollection attributes = 
   TypeDescriptor.GetAttributes(MyProperty);
if(attributes[typeof(RecommendedAsConfigurableAttribute)].Equals(RecommendedAsConfigurableAttribute.Yes))
 {
   // Insert code here.
}

C++

AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ RecommendedAsConfigurableAttribute::typeid ]->Equals(
 RecommendedAsConfigurableAttribute::Yes ) )
{
   // Insert code here.
}

J#

AttributeCollection attributes = 
    TypeDescriptor.GetAttributes("MyProperty");

if (attributes.get_Item(RecommendedAsConfigurableAttribute.class.
    ToType()).Equals(RecommendedAsConfigurableAttribute.Yes)) {
        // Insert code here.
}

継承階層

System.Object
   System.Attribute
    System.ComponentModel.RecommendedAsConfigurableAttribute

スレッド セーフ

この型の 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
サポート対象 : 1.0、1.1
2.0 では、互換性のために残されています (コンパイル時に警告)

参照

関連項目
RecommendedAsConfigurableAttribute メンバ
System.ComponentModel 名前空間
Attribute
PropertyDescriptor クラス
AttributeCollection クラス
PropertyDescriptorCollection クラス

RecommendedAsConfigurableAttribute コンストラクタ

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

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

Visual Basic (宣言)

Public Sub New ( _
    recommendedAsConfigurable As Boolean _
)

Visual Basic (使用法)

Dim recommendedAsConfigurable As Boolean

Dim instance As New RecommendedAsConfigurableAttribute(recommendedAsConfigurable)

C#

public RecommendedAsConfigurableAttribute (
    bool recommendedAsConfigurable
)

C++

public:
RecommendedAsConfigurableAttribute (
    bool recommendedAsConfigurable
)

J#

public RecommendedAsConfigurableAttribute (
    boolean recommendedAsConfigurable
)

JScript

public function RecommendedAsConfigurableAttribute
 (
    recommendedAsConfigurable : boolean
)

パラメータ

recommendedAsConfigurable

この属性が関連付けられているプロパティをアプリケーションの設定値として使用できる場合は true。それ以外の場合は false。

使用例

プロパティをアプリケーションの設定値として使用できるようにマークする例を次に示します。このコードは、新しい RecommendedAsConfigurableAttribute を作成し、その値を RecommendedAsConfigurableAttribute.Yes に設定してから、その属性をプロパティに関連付けます。

Visual Basic

<RecommendedAsConfigurable(True)> _
Public Property MyProperty() As
 Integer
    Get
        ' Insert code here.
        Return 0
    End Get
    Set
        ' Insert code here.
    End Set
End Property

C#

[RecommendedAsConfigurable(true)]
public int MyProperty {
   get {
      // Insert code here.
      return 0;
   }
   set {
      // Insert code here.
   }
}
   

C++

public:
   [RecommendedAsConfigurable(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here.
         return 0;
      }
      void set( int value
 )
      {
         
         // Insert code here.
      }
   }

J#

/** @attribute RecommendedAsConfigurable(true)
 */
/** @property 
 */
public int get_MyProperty()
{
    // Insert code here.
    return 0;
} //get_MyProperty

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

プラットフォーム

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

参照

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

RecommendedAsConfigurableAttribute フィールド

パブリック フィールド

	名前	説明
	Default	RecommendedAsConfigurableAttribute の既定値 (No) を指定します。static フィールドは読み取り専用です。
	No	プロパティをアプリケーションの設定値として使用できないことを指定します。static フィールドは読み取り専用です。
	Yes	プロパティをアプリケーションの設定値として使用できることを指定します。static フィールドは読み取り専用です。

参照

関連項目

RecommendedAsConfigurableAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor クラス
AttributeCollection クラス
PropertyDescriptorCollection クラス

RecommendedAsConfigurableAttribute プロパティ

パブリック プロパティ

	名前	説明
	RecommendedAsConfigurable	この属性が関連付けられているプロパティをアプリケーション設定値として使用できるかどうかを示す値を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

関連項目

RecommendedAsConfigurableAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor クラス
AttributeCollection クラス
PropertyDescriptorCollection クラス

RecommendedAsConfigurableAttribute メソッド

パブリック メソッド

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

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。 このインスタンスと指定したオブジェクトが等しいかどうかを示します。
	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 から継承されます。)

参照

関連項目

RecommendedAsConfigurableAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor クラス
AttributeCollection クラス
PropertyDescriptorCollection クラス

RecommendedAsConfigurableAttribute メンバ

プロパティをアプリケーションの設定値として使用できることを指定します。

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

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

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

パブリック フィールド

	名前	説明
	Default	RecommendedAsConfigurableAttribute の既定値 (No) を指定します。static フィールドは読み取り専用です。
	No	プロパティをアプリケーションの設定値として使用できないことを指定します。static フィールドは読み取り専用です。
	Yes	プロパティをアプリケーションの設定値として使用できることを指定します。static フィールドは読み取り専用です。

パブリック プロパティ

	名前	説明
	RecommendedAsConfigurable	この属性が関連付けられているプロパティをアプリケーション設定値として使用できるかどうかを示す値を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリック メソッド

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

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。 このインスタンスと指定したオブジェクトが等しいかどうかを示します。
	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 から継承されます。)

参照

関連項目

RecommendedAsConfigurableAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor クラス
AttributeCollection クラス
PropertyDescriptorCollection クラス