SettingsBase Class

Definition

Provides the base class used to support user property settings.

C#
public abstract class SettingsBase
Inheritance
SettingsBase
Derived

Remarks

ASP.NET Web Forms and Windows Forms both use the same configuration settings infrastructure to support user settings. User settings within ASP.NET are often referred to as ASP.NET Profile. The settings infrastructure includes the SettingsBase base class, the SettingsProperty class, the SettingsPropertyValue class, the SettingsContext class, the SettingsProvider class, and the SettingAttribute

class.

The Settings base classes provide only a common infrastructure for defining and persisting settings properties. Depending on how these base classes are derived and their run-time environment, the settings API can provide different levels of functionality. For example, ASP.NET Profile uses the settings base classes to provide per-user settings that are saved and loaded according to request semantics.

Constructors

SettingsBase()

Initializes a new instance of the SettingsBase class.

Properties

Context

Gets the associated settings context.

IsSynchronized

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

Item[String]

Gets or sets the value of the specified settings property.

Properties

Gets the collection of settings properties.

PropertyValues

Gets a collection of settings property values.

Providers

Gets a collection of settings providers.

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)
Initialize(SettingsContext, SettingsPropertyCollection, SettingsProviderCollection)

Initializes internal properties used by SettingsBase object.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Save()

Stores the current values of the settings properties.

Synchronized(SettingsBase)

Provides a SettingsBase class that is synchronized (thread safe).

ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7 (package-provided), 4.7, 4.7.1 (package-provided), 4.7.1, 4.7.2 (package-provided), 4.7.2, 4.8 (package-provided), 4.8, 4.8.1
.NET Standard 2.0 (package-provided)
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

See also