Export (0) Print
Expand All

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.

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

[AttributeUsageAttribute(AttributeTargets.Property)]
[ObsoleteAttribute("Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.")]
public class RecommendedAsConfigurableAttribute : 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 .NET 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 RecommendedAsConfigurableAttribute.Yes or RecommendedAsConfigurableAttribute.No.

For more information, see Attributes Overview and Extending Metadata Using Attributes.

.

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

[RecommendedAsConfigurable(true)]
 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 = 
   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.
}

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

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

System.Object
  System.Attribute
    System.ComponentModel.RecommendedAsConfigurableAttribute

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

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 Framework

Supported 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

Community Additions

ADD
Show:
© 2014 Microsoft