SettingsContext Class

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Provides contextual information that the provider can use when persisting settings.

public ref class SettingsContext : System::Collections::Hashtable

public class SettingsContext : System.Collections.Hashtable

type SettingsContext = class
    inherit Hashtable

Public Class SettingsContext
Inherits Hashtable

Inheritance

Object

Hashtable

SettingsContext

Remarks

The SettingsContext class is the base class used by applications to provide contextual information to the settings provider. Although the class is not abstract, an application can choose to create a specialized class that inherits from SettingsContext class and provides additional information to specific types of providers. The provider can then examine contextual settings when writing properties.

The primary purpose of the SettingsContext class is to provide features that use the SettingsBase class and related infrastructure. The SettingsContext class provides additional feature-specific contextual information about the property data being stored by the SettingsBase instance. Therefore, it is very simple to store additional information in a SettingsContext class without deriving from it (or from other Settings* classes) in order to support additional feature-specific context information.

For example, ASP.NET uses the SettingsContext class to pass along the username associated with the data managed by a SettingsBase instance, as well as a property indicating whether the user is considered authenticated. In this way, ASP.NET uses the SettingsContext class to identify authenticated versus anonymous Profile data.

Constructors

SettingsContext()	Initializes a new instance of the SettingsContext class.
SettingsContext(SerializationInfo, StreamingContext)	Constructor for deserializing a SettingsContext instance from state file (binary serialization).

Properties

comparer	Gets or sets the IComparer to use for the Hashtable. (Inherited from Hashtable)
Count	Gets the number of key/value pairs contained in the Hashtable. (Inherited from Hashtable)
EqualityComparer	Gets the IEqualityComparer to use for the Hashtable. (Inherited from Hashtable)
hcp	Gets or sets the object that can dispense hash codes. (Inherited from Hashtable)
IsFixedSize	Gets a value indicating whether the Hashtable has a fixed size. (Inherited from Hashtable)
IsReadOnly	Gets a value indicating whether the Hashtable is read-only. (Inherited from Hashtable)
IsSynchronized	Gets a value indicating whether access to the Hashtable is synchronized (thread safe). (Inherited from Hashtable)
Item[Object]	Gets or sets the value associated with the specified key. (Inherited from Hashtable)
Keys	Gets an ICollection containing the keys in the Hashtable. (Inherited from Hashtable)
SyncRoot	Gets an object that can be used to synchronize access to the Hashtable. (Inherited from Hashtable)
Values	Gets an ICollection containing the values in the Hashtable. (Inherited from Hashtable)

Methods

Add(Object, Object)	Adds an element with the specified key and value into the Hashtable. (Inherited from Hashtable)
Clear()	Removes all elements from the Hashtable. (Inherited from Hashtable)
Clone()	Creates a shallow copy of the Hashtable. (Inherited from Hashtable)
Contains(Object)	Determines whether the Hashtable contains a specific key. (Inherited from Hashtable)
ContainsKey(Object)	Determines whether the Hashtable contains a specific key. (Inherited from Hashtable)
ContainsValue(Object)	Determines whether the Hashtable contains a specific value. (Inherited from Hashtable)
CopyTo(Array, Int32)	Copies the Hashtable elements to a one-dimensional Array instance at the specified index. (Inherited from Hashtable)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an IDictionaryEnumerator that iterates through the Hashtable. (Inherited from Hashtable)
GetHash(Object)	Returns the hash code for the specified key. (Inherited from Hashtable)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext)	Implements the ISerializable interface and returns the data needed to serialize the Hashtable. (Inherited from Hashtable)
GetType()	Gets the Type of the current instance. (Inherited from Object)
KeyEquals(Object, Object)	Compares a specific Object with a specific key in the Hashtable. (Inherited from Hashtable)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserialization(Object)	Implements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from Hashtable)
Remove(Object)	Removes the element with the specified key from the Hashtable. (Inherited from Hashtable)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

See also

• Administering ASP.NET Web Sites