.NET Framework Class Library
RecommendedAsConfigurableAttribute Class

Note: This API is now obsolete. The non-obsolete alternative is SettingsBindableAttribute.

Specifies that the property can be used as an application setting.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelRecommendedAsConfigurableAttribute

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/hywx11ft_en-us_VS_110_3_0_0_0_0%]([%$TOPIC/hywx11ft_en-us_VS_110_3_0_0_0_1%].Property)> _
<[%$TOPIC/hywx11ft_en-us_VS_110_3_0_0_0_2%]("Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.")> _
Public Class RecommendedAsConfigurableAttribute _
	Inherits [%$TOPIC/hywx11ft_en-us_VS_110_3_0_0_0_3%]
[[%$TOPIC/hywx11ft_en-us_VS_110_3_0_1_0_0%]([%$TOPIC/hywx11ft_en-us_VS_110_3_0_1_0_1%].Property)]
[[%$TOPIC/hywx11ft_en-us_VS_110_3_0_1_0_2%]("Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.")]
public class RecommendedAsConfigurableAttribute : [%$TOPIC/hywx11ft_en-us_VS_110_3_0_1_0_3%]
[[%$TOPIC/hywx11ft_en-us_VS_110_3_0_2_0_0%]([%$TOPIC/hywx11ft_en-us_VS_110_3_0_2_0_1%]::Property)]
[[%$TOPIC/hywx11ft_en-us_VS_110_3_0_2_0_2%](L"Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.")]
public ref class RecommendedAsConfigurableAttribute : public [%$TOPIC/hywx11ft_en-us_VS_110_3_0_2_0_3%]
[<[%$TOPIC/hywx11ft_en-us_VS_110_3_0_3_0_0%]([%$TOPIC/hywx11ft_en-us_VS_110_3_0_3_0_1%].Property)>]
[<[%$TOPIC/hywx11ft_en-us_VS_110_3_0_3_0_2%]("Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.")>]
type RecommendedAsConfigurableAttribute =  
    class 
        inherit [%$TOPIC/hywx11ft_en-us_VS_110_3_0_3_0_3%] 
    end

The RecommendedAsConfigurableAttribute type exposes the following members.

Constructors
  NameDescription
Public method RecommendedAsConfigurableAttributeInitializes a new instance of the RecommendedAsConfigurableAttribute class.
Top
Properties
  NameDescription
Public property RecommendedAsConfigurableGets a value indicating whether the property this attribute is bound to can be used as an application setting.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsIndicates whether this instance and a specified object are equal. (Overrides AttributeEquals(Object).)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCodeReturns the hash code for this instance. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeIndicates whether the value of this instance is the default value for the class. (Overrides AttributeIsDefaultAttribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member DefaultSpecifies the default value for the RecommendedAsConfigurableAttribute, which is No. This static field is read-only.
Public field Static member NoSpecifies that a property cannot be used as an application setting. This static field is read-only.
Public field Static member YesSpecifies that a property can be used as an application setting. This static field is read-only.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

Properties that are marked with the RecommendedAsConfigurableAttribute set to true display when you expand the ConfigurableProperties line in the Properties window. A property that has no recommended setting or that is marked with RecommendedAsConfigurableAttribute set to false is not shown and is an unlikely candidate for being an application setting. The default is false.

You can bind a property that does not have a RecommendedAsConfigurableAttribute to a setting in Visual Studio by clicking the ellipsis button (…) under Settings in the Properties window and selecting the appropriate property from the list.

NoteNote

When you mark a property with RecommendedAsConfigurableAttribute set to true, the value of this attribute is set to the constant member Yes. For a property marked with RecommendedAsConfigurableAttribute set to value false, the value is No. Therefore, when you want to check the value of this attribute in your code, you must specify the attribute as RecommendedAsConfigurableAttributeYes or RecommendedAsConfigurableAttributeNo.

For more information, see Extending Metadata Using Attributes.

.

Examples

The following example marks a property as usable as an application setting.

<RecommendedAsConfigurable(True)> _
Public Property MyProperty() As Integer 
    Get 
        ' Insert code here. 
        Return 0
    End Get 
    Set 
        ' Insert code here. 
    End Set  
End Property
[RecommendedAsConfigurable(true)]
 public int MyProperty {
    get {
       // Insert code here. 
       return 0;
    }
    set {
       // Insert code here.
    }
 }
public:
   [RecommendedAsConfigurable(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here. 
         return 0;
      }
      void set( int /*value*/ )
      {
         // Insert code here.
      }
   }

The next example shows how to check the value of the RecommendedAsConfigurableAttribute for MyProperty. First the code gets a PropertyDescriptorCollection with all the properties for the object. Next it indexes into the PropertyDescriptorCollection to get MyProperty. Then it returns the attributes for this property and saves them in the attributes variable.

This example presents two different ways of checking the value of the RecommendedAsConfigurableAttribute. In the second code fragment, the example calls the Equals method. In the last code fragment, the example uses the RecommendedAsConfigurable property to check the value.

' 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
// 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.
}
// 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.
}

If you marked a class with the RecommendedAsConfigurableAttribute, use the following code to check the value.

Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(RecommendedAsConfigurableAttribute)).Equals(RecommendedAsConfigurableAttribute.Yes) Then 
    ' Insert code here. 
End If
AttributeCollection attributes = 
   TypeDescriptor.GetAttributes(MyProperty);
if(attributes[typeof(RecommendedAsConfigurableAttribute)].Equals(RecommendedAsConfigurableAttribute.Yes)) {
   // Insert code here.
}
AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ RecommendedAsConfigurableAttribute::typeid ]->Equals( RecommendedAsConfigurableAttribute::Yes ) )
{
   // Insert code here.
}
Version Information

.NET Framework

Supported in: 1.1, 1.0
Obsolete (compiler warning) in 4.5.2
Obsolete (compiler warning) in 4.5.1
Obsolete (compiler warning) in 4.5
Obsolete (compiler warning) in 4
Obsolete (compiler warning) in 3.5
Obsolete (compiler warning) in 3.5 SP1
Obsolete (compiler warning) in 3.0
Obsolete (compiler warning) in 3.0 SP1
Obsolete (compiler warning) in 3.0 SP2
Obsolete (compiler warning) in 2.0
Obsolete (compiler warning) in 2.0 SP1
Obsolete (compiler warning) in 2.0 SP2

.NET Framework Client Profile

Obsolete (compiler warning) in 4
Obsolete (compiler warning) in 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.