SettingsContext Class

 

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

Namespace:   System.Configuration
Assembly:  System (in System.dll)

System::Object
  System.Collections::Hashtable
    System.Configuration::SettingsContext

[SerializableAttribute]
public ref class SettingsContext : Hashtable

NameDescription
System_CAPS_pubmethodSettingsContext()

Initializes a new instance of the SettingsContext class.

NameDescription
System_CAPS_protpropertycomparer

Obsolete.Gets or sets the IComparer to use for the Hashtable.(Inherited from Hashtable.)

System_CAPS_pubpropertyCount

Gets the number of key/value pairs contained in the Hashtable.(Inherited from Hashtable.)

System_CAPS_protpropertyEqualityComparer

Gets the IEqualityComparer to use for the Hashtable.(Inherited from Hashtable.)

System_CAPS_protpropertyhcp

Obsolete.Gets or sets the object that can dispense hash codes.(Inherited from Hashtable.)

System_CAPS_pubpropertyIsFixedSize

Gets a value indicating whether the Hashtable has a fixed size.(Inherited from Hashtable.)

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether the Hashtable is read-only.(Inherited from Hashtable.)

System_CAPS_pubpropertyIsSynchronized

Gets a value indicating whether access to the Hashtable is synchronized (thread safe).(Inherited from Hashtable.)

System_CAPS_pubpropertyItem[Object^]

Gets or sets the value associated with the specified key.(Inherited from Hashtable.)

System_CAPS_pubpropertyKeys

Gets an ICollection containing the keys in the Hashtable.(Inherited from Hashtable.)

System_CAPS_pubpropertySyncRoot

Gets an object that can be used to synchronize access to the Hashtable.(Inherited from Hashtable.)

System_CAPS_pubpropertyValues

Gets an ICollection containing the values in the Hashtable.(Inherited from Hashtable.)

NameDescription
System_CAPS_pubmethodAdd(Object^, Object^)

Adds an element with the specified key and value into the Hashtable.(Inherited from Hashtable.)

System_CAPS_pubmethodClear()

Removes all elements from the Hashtable.(Inherited from Hashtable.)

System_CAPS_pubmethodClone()

Creates a shallow copy of the Hashtable.(Inherited from Hashtable.)

System_CAPS_pubmethodContains(Object^)

Determines whether the Hashtable contains a specific key.(Inherited from Hashtable.)

System_CAPS_pubmethodContainsKey(Object^)

Determines whether the Hashtable contains a specific key.(Inherited from Hashtable.)

System_CAPS_pubmethodContainsValue(Object^)

Determines whether the Hashtable contains a specific value.(Inherited from Hashtable.)

System_CAPS_pubmethodCopyTo(Array^, Int32)

Copies the Hashtable elements to a one-dimensional Array instance at the specified index.(Inherited from Hashtable.)

System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns an IDictionaryEnumerator that iterates through the Hashtable.(Inherited from Hashtable.)

System_CAPS_protmethodGetHash(Object^)

Returns the hash code for the specified key.(Inherited from Hashtable.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetObjectData(SerializationInfo^, StreamingContext)

Implements the ISerializable interface and returns the data needed to serialize the Hashtable.(Inherited from Hashtable.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodKeyEquals(Object^, Object^)

Compares a specific Object with a specific key in the Hashtable.(Inherited from Hashtable.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodOnDeserialization(Object^)

Implements the ISerializable interface and raises the deserialization event when the deserialization is complete.(Inherited from Hashtable.)

System_CAPS_pubmethodRemove(Object^)

Removes the element with the specified key from the Hashtable.(Inherited from Hashtable.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable::GetEnumerator()

Returns an enumerator that iterates through a collection.(Inherited from Hashtable.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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.

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: