SettingsProperty Class
Used internally as the class that represents metadata about an individual configuration property.
Assembly: System (in System.dll)
| Name | Description | |
|---|---|---|
![]() | SettingsProperty(SettingsProperty^) | Initializes a new instance of the SettingsProperty class, based on the supplied parameter. |
![]() | SettingsProperty(String^) | Initializes a new instance of the SettingsProperty class. based on the supplied parameter. |
![]() | SettingsProperty(String^, Type^, SettingsProvider^, Boolean, Object^, SettingsSerializeAs, SettingsAttributeDictionary^, Boolean, Boolean) | Creates a new instance of the SettingsProperty class based on the supplied parameters. |
| Name | Description | |
|---|---|---|
![]() | Attributes | Gets a SettingsAttributeDictionary object containing the attributes of the SettingsProperty object. |
![]() | DefaultValue | Gets or sets the default value of the SettingsProperty object. |
![]() | IsReadOnly | Gets or sets a value specifying whether a SettingsProperty object is read-only. |
![]() | Name | Gets or sets the name of the SettingsProperty. |
![]() | PropertyType | Gets or sets the type for the SettingsProperty. |
![]() | Provider | Gets or sets the provider for the SettingsProperty. |
![]() | SerializeAs | Gets or sets a SettingsSerializeAs object for the SettingsProperty. |
![]() | ThrowOnErrorDeserializing | Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully deserialized. |
![]() | ThrowOnErrorSerializing | Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully serialized. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object^) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType() | |
![]() | MemberwiseClone() | |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
SettingsProperty is used to describe settings properties of a class derived from SettingsBase. The Settings API allows a collection of settings properties to be grouped into a common language runtime class.
When persisting settings, the SettingsBase base class asks for a collection of SettingsProperty objects, grouped in a collection of type SettingsPropertyCollection. It does this by calling its own Properties member. Inherited classes should return a collection of properties to persist.
Each SettingsProperty object includes metadata about the property, including the following:
Name.
Default value.
Property type.
Serialization method.
Provider to use for persistence.
Other arbitrary attributes that are context and provider specific.
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.


