SettingsSavedEventArgs Class
Provides data for the ClientSettingsProvider.SettingsSaved event.
Namespace: System.Web.ClientServices.Providers
Assembly: System.Web.Extensions (in System.Web.Extensions.dll)
The SettingsSavedEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
 | SettingsSavedEventArgs | Initializes a new instance of the SettingsSavedEventArgs class. |
| Name | Description | |
|---|---|---|
| FailedSettingsList | Gets the settings that the ClientSettingsProvider was unable to save to the server. |
| 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 a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
The ClientSettingsProvider.SettingsSaved event occurs after the settings provider accesses the settings service, even if the settings were not successfully saved. One reason that the provider might fail to save the settings is if the current user has been logged out. You can use the FailedSettingsList property to determine whether any settings were not successfully saved.
This event does not occur if the settings provider cannot access the settings service, which instead causes the provider to throw a WebException.
For more information about handling events, see Consuming Events.
The following example code demonstrates how to use this class to display a list of settings that were not successfully saved.
private void AttachSettingsSavedEventHandler() { ((ClientSettingsProvider)Properties.Settings.Default.Providers ["System.Web.ClientServices.Providers.ClientSettingsProvider"]) .SettingsSaved += new EventHandler<SettingsSavedEventArgs>(Form1_SettingsSaved); } private void Form1_SettingsSaved(object sender, SettingsSavedEventArgs e) { // If any settings were not saved, display a list of them. if (e.FailedSettingsList.Count > 0) { String failedSettings = String.Join( Environment.NewLine, e.FailedSettingsList.ToArray()); String message = String.Format("{0}{1}{1}{2}", "The following setting(s) were not saved:", Environment.NewLine, failedSettings); MessageBox.Show(message, "Unable to save settings", MessageBoxButtons.OK, MessageBoxIcon.Warning); } }
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
