RecommendedAsConfigurableAttribute Class

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.TypeConverter.dll

Source:

RecommendedAsConfigurableAttribute.cs

Caution

RecommendedAsConfigurableAttribute has been deprecated. Use System.ComponentModel.SettingsBindableAttribute instead.

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

public ref class RecommendedAsConfigurableAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
[System.Obsolete("RecommendedAsConfigurableAttribute has been deprecated. Use System.ComponentModel.SettingsBindableAttribute instead.")]
public class RecommendedAsConfigurableAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
[<System.Obsolete("RecommendedAsConfigurableAttribute has been deprecated. Use System.ComponentModel.SettingsBindableAttribute instead.")>]
type RecommendedAsConfigurableAttribute = class
    inherit Attribute

Public Class RecommendedAsConfigurableAttribute
Inherits Attribute

Inheritance

Object

Attribute

RecommendedAsConfigurableAttribute

Attributes

AttributeUsageAttribute ObsoleteAttribute

Examples

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

public:
   [RecommendedAsConfigurable(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here.
         return 0;
      }
      void set( int /*value*/ )
      {
         // Insert code here.
      }
   }

[RecommendedAsConfigurable(true)]
 public int MyProperty {
    get {
       // Insert code here.
       return 0;
    }
    set {
       // Insert code here.
    }
 }

<RecommendedAsConfigurable(True)> _
Public Property MyProperty() As Integer
    Get
        ' Insert code here.
        Return 0
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

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[ RecommendedAsConfigurableAttribute::typeid ]->Equals( RecommendedAsConfigurableAttribute::Yes ) )
{
   // Insert code here.
}

// This is another way to see if the property is recommended as configurable.
RecommendedAsConfigurableAttribute^ myAttribute = dynamic_cast<RecommendedAsConfigurableAttribute^>(attributes[ RecommendedAsConfigurableAttribute::typeid ]);
if ( myAttribute->RecommendedAsConfigurable )
{
   // Insert code here.
}

// 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.
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 RecommendedAsConfigurableAttribute, use the following code to check the value.

AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ RecommendedAsConfigurableAttribute::typeid ]->Equals( RecommendedAsConfigurableAttribute::Yes ) )
{
   // Insert code here.
}

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

Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(RecommendedAsConfigurableAttribute)).Equals(RecommendedAsConfigurableAttribute.Yes) Then
    ' Insert code here.
End If

Remarks

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

.

Constructors

RecommendedAsConfigurableAttribute(Boolean)

Initializes a new instance of the RecommendedAsConfigurableAttribute class.

Fields

Default	Specifies the default value for the RecommendedAsConfigurableAttribute, 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.

Properties

RecommendedAsConfigurable	Gets a value indicating whether the property this attribute is bound to can be used as an application setting.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Indicates whether this instance and a specified object are equal.
GetHashCode()	Returns the hash code for this instance.
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.
Match(Object)	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)

See also

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection