System.Configuration.SettingsBase Class Reference

Provides the base class used to support user property settings. More...

Inheritance diagram for System.Configuration.SettingsBase:

Collaboration diagram for System.Configuration.SettingsBase:

Public Member Functions
void	Initialize (SettingsContext context, SettingsPropertyCollection properties, SettingsProviderCollection providers)
	Initializes internal properties used by T:System.Configuration.SettingsBase object. More...
virtual void	Save ()
	Stores the current values of the settings properties. More...

Static Public Member Functions
static SettingsBase	Synchronized (SettingsBase settingsBase)
	Provides a T:System.Configuration.SettingsBase class that is synchronized (thread safe). More...

Public Attributes
virtual SettingsPropertyCollection	Properties => _Properties
	Gets the collection of settings properties. More...
virtual SettingsProviderCollection	Providers => _Providers
	Gets a collection of settings providers. More...
virtual SettingsPropertyValueCollection	PropertyValues => _PropertyValues
	Gets a collection of settings property values. More...
virtual SettingsContext	Context => _Context
	Gets the associated settings context. More...

Protected Member Functions
	SettingsBase ()
	Initializes a new instance of the T:System.Configuration.SettingsBase class. More...

Properties
virtual object	this[string propertyName] [get, set]
	Gets or sets the value of the specified settings property. More...
bool	IsSynchronized [get]
	Gets a value indicating whether access to the object is synchronized (thread safe). More...

Detailed Description

Provides the base class used to support user property settings.

Definition at line 6 of file SettingsBase.cs.

Constructor & Destructor Documentation

SettingsBase()

System.Configuration.SettingsBase.SettingsBase ( )

protected

Initializes a new instance of the T:System.Configuration.SettingsBase class.

Definition at line 82 of file SettingsBase.cs.

Member Function Documentation

Initialize()

void System.Configuration.SettingsBase.Initialize	(	SettingsContext	context,
		SettingsPropertyCollection	properties,
		SettingsProviderCollection	providers
	)

Initializes internal properties used by T:System.Configuration.SettingsBase object.

Parameters

context	The settings context related to the settings properties.
properties	The settings properties that will be accessible from the T:System.Configuration.SettingsBase instance.
providers	The initialized providers that should be used when loading and saving property values.

Definition at line 147 of file SettingsBase.cs.

Save()

virtual void System.Configuration.SettingsBase.Save ( )

virtual

Stores the current values of the settings properties.

Reimplemented in System.Configuration.ApplicationSettingsBase.

Definition at line 155 of file SettingsBase.cs.

Synchronized()

static SettingsBase System.Configuration.SettingsBase.Synchronized ( SettingsBase  settingsBase )

static

Provides a T:System.Configuration.SettingsBase class that is synchronized (thread safe).

Parameters

settingsBase

The class used to support user property settings.

Returns

A T:System.Configuration.SettingsBase class that is synchronized.

Definition at line 222 of file SettingsBase.cs.

Member Data Documentation

Context

virtual SettingsContext System.Configuration.SettingsBase.Context => _Context

Gets the associated settings context.

Returns

A T:System.Configuration.SettingsContext associated with the settings instance.

Definition at line 67 of file SettingsBase.cs.

Properties

virtual SettingsPropertyCollection System.Configuration.SettingsBase.Properties => _Properties

Gets the collection of settings properties.

Returns

A T:System.Configuration.SettingsPropertyCollection collection containing all the T:System.Configuration.SettingsProperty objects.

Definition at line 55 of file SettingsBase.cs.

PropertyValues

virtual SettingsPropertyValueCollection System.Configuration.SettingsBase.PropertyValues => _PropertyValues

Gets a collection of settings property values.

Returns

A collection of T:System.Configuration.SettingsPropertyValue objects representing the actual data values for the properties managed by the T:System.Configuration.SettingsBase instance.

Definition at line 63 of file SettingsBase.cs.

Providers

virtual SettingsProviderCollection System.Configuration.SettingsBase.Providers => _Providers

Gets a collection of settings providers.

Returns

A T:System.Configuration.SettingsProviderCollection containing T:System.Configuration.SettingsProvider objects.

Definition at line 59 of file SettingsBase.cs.

Property Documentation

IsSynchronized

bool System.Configuration.SettingsBase.IsSynchronized

get

Gets a value indicating whether access to the object is synchronized (thread safe).

Returns

true if access to the T:System.Configuration.SettingsBase is synchronized; otherwise, false.

Definition at line 74 of file SettingsBase.cs.

this[string propertyName]

virtual object System.Configuration.SettingsBase.this[string propertyName]

getset

Gets or sets the value of the specified settings property.

Parameters

propertyName

A T:System.String containing the name of the property to access.

Returns

If found, the value of the named settings property.

Exceptions

T:System.Configuration.SettingsPropertyNotFoundException	There are no properties associated with the current object, or the specified property could not be found.
T:System.Configuration.SettingsPropertyIsReadOnlyException	An attempt was made to set a read-only property.
T:System.Configuration.SettingsPropertyWrongTypeException	The value supplied is of a type incompatible with the settings property, during a set operation.

Definition at line 25 of file SettingsBase.cs.

---

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

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