RecommendedAsConfigurableAttribute Class
Collapse the table of content
Expand the table of content

RecommendedAsConfigurableAttribute Class

obsoleteCodeEntityT:System.ComponentModel.SettingsBindableAttributeNote: This API is now obsolete.

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

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)


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


Initializes a new instance of the RecommendedAsConfigurableAttribute class.


Gets a value indicating whether the property this attribute is bound to can be used as an application setting.


When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)


Indicates whether this instance and a specified object are equal.(Overrides Attribute.Equals(Object).)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Returns the hash code for this instance.(Overrides Attribute.GetHashCode().)


Gets the Type of the current instance.(Inherited from Object.)


Indicates whether the value of this instance is the default value for the class.(Overrides Attribute.IsDefaultAttribute().)


When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)


Specifies the default value for the RecommendedAsConfigurableAttribute, which is No. This static field is read-only.


Specifies that a property cannot be used as an application setting. This static field is read-only.


Specifies that a property can be used as an application setting. This static field is read-only.

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

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)


Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

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.


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 RecommendedAsConfigurableAttribute.Yes or RecommendedAsConfigurableAttribute.No.

For more information, see Extending Metadata Using Attributes.


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

 public int MyProperty {
    get {
       // Insert code here.
       return 0;
    set {
       // 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.
AttributeCollection 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 = 
if(myAttribute.RecommendedAsConfigurable) {
   // Insert code here.

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

AttributeCollection attributes = 
if(attributes[typeof(RecommendedAsConfigurableAttribute)].Equals(RecommendedAsConfigurableAttribute.Yes)) {
   // Insert code here.

.NET Framework
Available since 1.1

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

Return to top
© 2015 Microsoft