Specifies that the property can be used as an application setting.
Assembly: System (in System.dll)
Initializes a new instance of theclass.
Indicates whether this instance and a specified object are equal.(Overrides Attribute.Equals(Object).)
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
Returns the hash code for this instance.(Overrides Attribute.GetHashCode().)
Indicates whether the value of this instance is the default value for the class.(Overrides Attribute.IsDefaultAttribute().)
When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)
Returns a string that represents the current object.(Inherited from Object.)
Specifies the default value for the No. This static field is read-only., which is
Specifies that a property cannot be used as an application setting. This static field is read-only.
Specifies that a property can be used as an application setting. This static field is read-only.
|_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)|
Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)
|_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)|
Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)
Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)
|_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)|
Provides access to properties and methods exposed by an object.(Inherited from Attribute.)
Properties that are marked with theset 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 ato a setting in Visual Studio 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 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.set to true, the value of this attribute is set to the constant member
For more information, see Extending Metadata Using Attributes.
The following example marks a property as usable as an application setting.
<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 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.for
' 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.
Available since 1.1
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.