SettingsProperty Class

Reference

Definition

Namespace:: System.Configuration

Assembly:: System.Configuration.ConfigurationManager.dll

Assembly:: System.dll

Package:: System.Configuration.ConfigurationManager v6.0.0

Package:: System.Configuration.ConfigurationManager v7.0.0

Package:: System.Configuration.ConfigurationManager v8.0.0

Package:: System.Configuration.ConfigurationManager v9.0.0-preview.2.24128.5

Source:: SettingsProperty.cs

Source:: SettingsProperty.cs

Source:: SettingsProperty.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Used internally as the class that represents metadata about an individual configuration property.

public ref class SettingsProperty

public class SettingsProperty

type SettingsProperty = class

Public Class SettingsProperty

Inheritance: Object
SettingsProperty

Remarks

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.

Constructors

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.

Properties

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.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to