ClientSettingsProvider Class

.NET Framework (current version)

Enables Windows-based applications to retrieve user settings from a Web settings service.

Namespace: System.Web.ClientServices.Providers
Assembly: System.Web.Extensions (in System.Web.Extensions.dll)

Inheritance Hierarchy

System::Object
System.Configuration.Provider::ProviderBase
System.Configuration::SettingsProvider
System.Web.ClientServices.Providers::ClientSettingsProvider

Syntax

C++

[SecurityCriticalAttribute]
[PermissionSetAttribute(SecurityAction::InheritanceDemand, Name = "FullTrust")]
public ref class ClientSettingsProvider : SettingsProvider, IApplicationSettingsProvider

Constructors

	Name	Description
	ClientSettingsProvider()	Initializes a new instance of the ClientSettingsProvider class.

Properties

	Name	Description
	ApplicationName	This property is not used by this class.(Overrides SettingsProvider::ApplicationName.)
	Description	Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).(Inherited from ProviderBase.)
	Name	Gets the friendly name used to refer to the provider during configuration.(Inherited from ProviderBase.)
	ServiceUri	Gets or sets the Web settings service location.

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetPreviousVersion(SettingsContext^, SettingsProperty^)	Gets the previous version of the specified property.
	GetPropertyMetadata(String^)	Gets a collection of metadata for all properties retrieved from the specified Web settings service.
	GetPropertyValues(SettingsContext^, SettingsPropertyCollection^)	Returns the collection of settings property values for the specified application instance and settings property group.(Overrides SettingsProvider::GetPropertyValues(SettingsContext^, SettingsPropertyCollection^).)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	Initialize(String^, NameValueCollection^)	Initializes the provider.(Overrides ProviderBase::Initialize(String^, NameValueCollection^).)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	Reset(SettingsContext^)	Resets all user settings to their default values.
	SetPropertyValues(SettingsContext^, SettingsPropertyValueCollection^)	Sets the values of the specified group of property settings.(Overrides SettingsProvider::SetPropertyValues(SettingsContext^, SettingsPropertyValueCollection^).)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	Upgrade(SettingsContext^, SettingsPropertyCollection^)	This method is not used by this class.

Events

	Name	Description
	SettingsSaved	Occurs after the settings provider attempts to save the property values to the Web settings service.

You can use client application services to retrieve user settings from an existing Web settings service by configuring your application to use the ClientSettingsProvider class. For more information, see How to: Configure Client Application Services. After configuration, you can get and set user settings through an application settings class derived from ApplicationSettingsBase and configured to use the ClientSettingsProvider class. You can use Visual Studio to generate a Settings class for your project (accessed as Properties.Settings.Default in C# and My.Settings in Visual Basic). For more information about application settings, see Application Settings Overview.

You can retrieve the current ClientSettingsProvider through the ApplicationSettingsBase::Providers property using the fully-qualified ClientSettingsProvider class name as a key. You can also retrieve the provider through the SettingsLoadedEventArgs::Provider property when you handle the ApplicationSettingsBase::SettingsLoaded event.

Note
This class contains a SecurityCriticalAttribute at the class level that applies to all members of the class. A run-time exception is thrown if the immediate caller is security-transparent or partially trusted. For more information about security-critical types and members, see Security-Transparent Code, Level 2.

Note
This class contains an inheritance demand at the class level that applies to all members. A SecurityException is thrown when the derived class does not have full-trust permission. For details about security demands, see Link Demands and Inheritance Demands.