This documentation is archived and is not being maintained.

ClientSettingsProvider.SettingsSaved Event

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

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

'Declaration
Public Event SettingsSaved As EventHandler(Of SettingsSavedEventArgs)
'Usage
Dim instance As ClientSettingsProvider 
Dim handler As EventHandler(Of SettingsSavedEventArgs)

AddHandler instance.SettingsSaved, handler

This 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 SettingsSavedEventArgs.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.

The following example code demonstrates how to use this event to display a list of settings that were not successfully saved.

Private WithEvents settingsProvider As ClientSettingsProvider = My.Settings _
    .Providers("System.Web.ClientServices.Providers.ClientSettingsProvider")

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

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5
Show: