Note: This API is now obsolete. The non-obsolete alternative is SettingsBindableAttribute.
Specifies that the property can be used as an application setting.
Assembly: System (in System.dll)
Thetype exposes the following members.
|Equals||Indicates whether this instance and a specified object are equal. (Overrides Attribute.Equals(Object).)|
|Finalize||Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)|
|GetHashCode||Returns the hash code for this instance. (Overrides Attribute.GetHashCode().)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|IsDefaultAttribute||Indicates whether the value of this instance is the default value for the class. (Overrides Attribute.IsDefaultAttribute().)|
|Match||When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)|
|MemberwiseClone||Creates a shallow copy of the current Object. (Inherited from Object.)|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
|Default||Specifies the default value for the , which is No. This static field is read-only.|
|No||Specifies that a property cannot be used as an application setting. This static field is read-only.|
|Yes||Specifies that a property can be used as an application setting. This static field is read-only.|
|_Attribute.GetIDsOfNames||Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)|
|_Attribute.GetTypeInfo||Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)|
|_Attribute.GetTypeInfoCount||Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)|
|_Attribute.Invoke||Provides access to properties and methods exposed by an object. (Inherited from Attribute.)|
Properties that are marked with the 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 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 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 set to true, the value of this attribute is set to the constant member Yes. For a property marked with 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.
The next example shows how to check the value of the 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 . 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.
If you marked a class with the , use the following code to check the value.
.NET FrameworkSupported in: 1.1, 1.0
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 ProfileObsolete (compiler warning) in 4
Obsolete (compiler warning) in 3.5 SP1
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.