System.Configuration.SettingsProperty Class Reference

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

Collaboration diagram for System.Configuration.SettingsProperty:

Public Member Functions
	SettingsProperty (string name)
	Initializes a new instance of the T:System.Configuration.SettingsProperty class. based on the supplied parameter. More...
	SettingsProperty (string name, Type propertyType, SettingsProvider provider, bool isReadOnly, object defaultValue, SettingsSerializeAs serializeAs, SettingsAttributeDictionary attributes, bool throwOnErrorDeserializing, bool throwOnErrorSerializing)
	Creates a new instance of the T:System.Configuration.SettingsProperty class based on the supplied parameters. More...
	SettingsProperty (SettingsProperty propertyToCopy)
	Initializes a new instance of the T:System.Configuration.SettingsProperty class, based on the supplied parameter. More...

Public Attributes
virtual SettingsAttributeDictionary	Attributes => _Attributes
	Gets a T:System.Configuration.SettingsAttributeDictionary object containing the attributes of the T:System.Configuration.SettingsProperty object. More...

Properties
virtual string	Name [get, set]
	Gets or sets the name of the T:System.Configuration.SettingsProperty. More...
virtual bool	IsReadOnly [get, set]
	Gets or sets a value specifying whether a T:System.Configuration.SettingsProperty object is read-only. More...
virtual object	DefaultValue [get, set]
	Gets or sets the default value of the T:System.Configuration.SettingsProperty object. More...
virtual Type	PropertyType [get, set]
	Gets or sets the type for the T:System.Configuration.SettingsProperty. More...
virtual SettingsSerializeAs	SerializeAs [get, set]
	Gets or sets a T:System.Configuration.SettingsSerializeAs object for the T:System.Configuration.SettingsProperty. More...
virtual SettingsProvider	Provider [get, set]
	Gets or sets the provider for the T:System.Configuration.SettingsProperty. More...
bool	ThrowOnErrorDeserializing [get, set]
	Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully deserialized. More...
bool	ThrowOnErrorSerializing [get, set]
	Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully serialized. More...

Detailed Description

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

Definition at line 4 of file SettingsProperty.cs.

Constructor & Destructor Documentation

SettingsProperty() [1/3]

System.Configuration.SettingsProperty.SettingsProperty

(

string

name

)

Initializes a new instance of the T:System.Configuration.SettingsProperty class. based on the supplied parameter.

Parameters

name	Specifies the name of an existing T:System.Configuration.SettingsProperty object.

Definition at line 145 of file SettingsProperty.cs.

SettingsProperty() [2/3]

System.Configuration.SettingsProperty.SettingsProperty	(	string	name,
		Type	propertyType,
		SettingsProvider	provider,
		bool	isReadOnly,
		object	defaultValue,
		SettingsSerializeAs	serializeAs,
		SettingsAttributeDictionary	attributes,
		bool	throwOnErrorDeserializing,
		bool	throwOnErrorSerializing
	)

Creates a new instance of the T:System.Configuration.SettingsProperty class based on the supplied parameters.

Parameters

name	The name of the T:System.Configuration.SettingsProperty object.
propertyType	The type of T:System.Configuration.SettingsProperty object.
provider	A T:System.Configuration.SettingsProvider object to use for persistence.
isReadOnly	A T:System.Boolean value specifying whether the T:System.Configuration.SettingsProperty object is read-only.
defaultValue	The default value of the T:System.Configuration.SettingsProperty object.
serializeAs	A T:System.Configuration.SettingsSerializeAs object. This object is an enumeration used to set the serialization scheme for storing application settings.
attributes	A T:System.Configuration.SettingsAttributeDictionary object.
throwOnErrorDeserializing	A Boolean value specifying whether an error will be thrown when the property is unsuccessfully deserialized.
throwOnErrorSerializing	A Boolean value specifying whether an error will be thrown when the property is unsuccessfully serialized.

Definition at line 161 of file SettingsProperty.cs.

SettingsProperty() [3/3]

System.Configuration.SettingsProperty.SettingsProperty

(

SettingsProperty

propertyToCopy

)

Initializes a new instance of the T:System.Configuration.SettingsProperty class, based on the supplied parameter.

Parameters

propertyToCopy

Specifies a copy of an existing T:System.Configuration.SettingsProperty object.

Definition at line 176 of file SettingsProperty.cs.

Member Data Documentation

Attributes

virtual SettingsAttributeDictionary System.Configuration.SettingsProperty.Attributes => _Attributes

Gets a T:System.Configuration.SettingsAttributeDictionary object containing the attributes of the T:System.Configuration.SettingsProperty object.

Returns

A T:System.Configuration.SettingsAttributeDictionary object.

Definition at line 111 of file SettingsProperty.cs.

Property Documentation

DefaultValue

virtual object System.Configuration.SettingsProperty.DefaultValue

getset

Gets or sets the default value of the T:System.Configuration.SettingsProperty object.

Returns

An object containing the default value of the T:System.Configuration.SettingsProperty object.

Definition at line 56 of file SettingsProperty.cs.

IsReadOnly

virtual bool System.Configuration.SettingsProperty.IsReadOnly

getset

Gets or sets a value specifying whether a T:System.Configuration.SettingsProperty object is read-only.

Returns

true if the T:System.Configuration.SettingsProperty is read-only; otherwise, false.

Definition at line 42 of file SettingsProperty.cs.

Name

virtual string System.Configuration.SettingsProperty.Name

getset

Gets or sets the name of the T:System.Configuration.SettingsProperty.

Returns

The name of the T:System.Configuration.SettingsProperty.

Definition at line 27 of file SettingsProperty.cs.

PropertyType

virtual Type System.Configuration.SettingsProperty.PropertyType

getset

Gets or sets the type for the T:System.Configuration.SettingsProperty.

Returns

The type for the T:System.Configuration.SettingsProperty.

Definition at line 70 of file SettingsProperty.cs.

Provider

virtual SettingsProvider System.Configuration.SettingsProperty.Provider

getset

Gets or sets the provider for the T:System.Configuration.SettingsProperty.

Returns

A T:System.Configuration.SettingsProvider object.

Definition at line 98 of file SettingsProperty.cs.

SerializeAs

virtual SettingsSerializeAs System.Configuration.SettingsProperty.SerializeAs

getset

Gets or sets a T:System.Configuration.SettingsSerializeAs object for the T:System.Configuration.SettingsProperty.

Returns

A T:System.Configuration.SettingsSerializeAs object.

Definition at line 84 of file SettingsProperty.cs.

ThrowOnErrorDeserializing

bool System.Configuration.SettingsProperty.ThrowOnErrorDeserializing

getset

Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully deserialized.

Returns

true if the error will be thrown when the property is unsuccessfully deserialized; otherwise, false.

Definition at line 117 of file SettingsProperty.cs.

ThrowOnErrorSerializing

bool System.Configuration.SettingsProperty.ThrowOnErrorSerializing

getset

Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully serialized.

Returns

true if the error will be thrown when the property is unsuccessfully serialized; otherwise, false.

Definition at line 132 of file SettingsProperty.cs.

---

The documentation for this class was generated from the following file:

• D:/All cs/System.Configuration/SettingsProperty.cs