System.ComponentModel.RecommendedAsConfigurableAttribute Class

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

See Also: RecommendedAsConfigurableAttribute Members

Syntax

[System.AttributeUsage(System.AttributeTargets.Property)]
[System.Obsolete("Use SettingsBindableAttribute instead of RecommendedAsConfigurableAttribute")]
public class RecommendedAsConfigurableAttribute : Attribute

Remarks

Properties that are marked with the System.ComponentModel.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 System.ComponentModel.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 System.ComponentModel.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.

Note:

When you mark a property with System.ComponentModel.RecommendedAsConfigurableAttribute set to true, the value of this attribute is set to the constant member RecommendedAsConfigurableAttribute.Yes. For a property marked with System.ComponentModel.RecommendedAsConfigurableAttribute set to value false, the value is RecommendedAsConfigurableAttribute.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.

.

Requirements

Namespace: System.ComponentModel
Assembly: System (in System.dll)
Assembly Versions: 1.0.3300.0, 1.0.5000.0, 2.0.0.0, 4.0.0.0