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)
'Declaration <AttributeUsageAttribute(AttributeTargets.Property)> _ <ObsoleteAttribute("Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.")> _ Public Class RecommendedAsConfigurableAttribute _ Inherits Attribute 'Usage Dim instance As RecommendedAsConfigurableAttribute
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 .NET 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.
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.
' 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
If you marked a class with the , use the following code to check the value.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET FrameworkSupported in: 1.1, 1.0
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