SettingsSavedEventArgs Class

SettingsSavedEventArgs Class


Provides data for the ClientSettingsProvider.SettingsSaved event.

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


public class SettingsSavedEventArgs : EventArgs


Initializes a new instance of the SettingsSavedEventArgs class.


Gets the settings that the ClientSettingsProvider was unable to save to the server.


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


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


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


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


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


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 NIB: 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()
        .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(

        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);

.NET Framework
Available since 3.5

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
© 2015 Microsoft