Export (0) Print
Expand All

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 _
	Inherits EventArgs

The SettingsSavedEventArgs type exposes the following members.

Public methodSettingsSavedEventArgsInitializes a new instance of the SettingsSavedEventArgs class.

Public propertyFailedSettingsListGets the settings that the ClientSettingsProvider was unable to save to the server.


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 WithEvents settingsProvider As ClientSettingsProvider = My.Settings _

Private Sub Form1_SettingsSaved(ByVal sender As Object, _
    ByVal e As SettingsSavedEventArgs) _
    Handles settingsProvider.SettingsSaved

    ' If any settings were not saved, display a list of them.
    If e.FailedSettingsList.Count > 0 Then

        Dim failedSettings As String = String.Join( _
            Environment.NewLine, e.FailedSettingsList.ToArray())

        Dim message As String = 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)

    End If

End Sub

.NET Framework

Supported in: 4, 3.5




Community Additions

© 2014 Microsoft