Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

RecommendedAsConfigurableAttribute Class

NOTE: This class 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
/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ 
/** @attribute ObsoleteAttribute("Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.") */ 
public class RecommendedAsConfigurableAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.Property) 
ObsoleteAttribute("Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.") 
public class RecommendedAsConfigurableAttribute extends Attribute
Not applicable.

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

/** @attribute RecommendedAsConfigurable(true)
 */
/** @property
 */
public int get_MyProperty()
{
    // Insert code here.
    return 0;
} //get_MyProperty

/** @property
 */
public void set_MyProperty(int value)
{
    // Insert code here.
} //set_MyProperty

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

// Gets the attributes for the property.
AttributeCollection attributes = 
    TypeDescriptor.GetProperties(this).get_Item(
    "MyProperty").get_Attributes();

// Checks to see if the value of the
// RecommendedAsConfigurableAttribute is Yes.
if (attributes.get_Item(RecommendedAsConfigurableAttribute.class.
    ToType()).Equals(RecommendedAsConfigurableAttribute.Yes)) {
    // Insert code here.
}

// This is another way to see if the property is recommended
// as configurable.
RecommendedAsConfigurableAttribute myAttribute =
    ((RecommendedAsConfigurableAttribute)(attributes.get_Item
    (RecommendedAsConfigurableAttribute.class.ToType())));

if (myAttribute.get_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.
}

AttributeCollection attributes = 
    TypeDescriptor.GetAttributes("MyProperty");

if (attributes.get_Item(RecommendedAsConfigurableAttribute.class.
    ToType()).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 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 1.0, 1.1, 2.0
Obsolete (compiler warning) in 3.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.