SettingsSavedEventArgs Класс

Определение

public ref class SettingsSavedEventArgs : EventArgs

public class SettingsSavedEventArgs : EventArgs

type SettingsSavedEventArgs = class
    inherit EventArgs

Public Class SettingsSavedEventArgs
Inherits EventArgs

Наследование

Object

EventArgs

SettingsSavedEventArgs

Примеры

В следующем примере кода показано, как использовать этот класс для отображения списка параметров, которые не были успешно сохранены.

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

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

Комментарии

Событие ClientSettingsProvider.SettingsSaved происходит после того, как поставщик параметров обращается к службе параметров, даже если параметры не были успешно сохранены. Одна из причин, по которой поставщик может не сохранить параметры, заключается в том, что текущий пользователь вышел из системы. Свойство можно использовать FailedSettingsList для определения того, не были ли параметры успешно сохранены.

Это событие не происходит, если поставщик параметров не может получить доступ к службе параметров, что вместо этого приводит к тому, что поставщик создает исключение WebException.

Дополнительные сведения об обработке событий см. в разделе "Обработка и создание событий".

См. также раздел

• FailedSettingsList
• ClientSettingsProvider
• SettingsSaved
• SettingsLoaded
• Logout()
• Logout()
• Службы клиентских приложений