SettingsSavedEventArgs Класс

Определение

Предоставляет данные для события SettingsSaved.Provides data for the SettingsSaved event.

public ref class SettingsSavedEventArgs : EventArgs
public class SettingsSavedEventArgs : EventArgs
type SettingsSavedEventArgs = class
    inherit EventArgs
Public Class SettingsSavedEventArgs
Inherits EventArgs
Наследование
SettingsSavedEventArgs

Примеры

В следующем примере кода показано, как использовать этот класс для отображения списка параметров, которые не были успешно сохранены.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);
    }
}
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 событие возникает после того, как поставщик параметров обращается к службе параметров, даже если параметры не были успешно сохранены.The ClientSettingsProvider.SettingsSaved event occurs after the settings provider accesses the settings service, even if the settings were not successfully saved. Одна из причин того, что поставщик может не сохранить параметры, — в случае выхода текущего пользователя. Чтобы определить, не FailedSettingsList были ли сохранены параметры, можно использовать свойство.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.

Это событие не происходит, если поставщик параметров не может получить доступ к службе параметров, что приводит к тому, что поставщик WebExceptionвыдает исключение.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 how to handle events, see Handling and Raising Events.

Конструкторы

SettingsSavedEventArgs(IEnumerable<String>)

Инициализирует новый экземпляр класса SettingsSavedEventArgs.Initializes a new instance of the SettingsSavedEventArgs class.

Свойства

FailedSettingsList

Возвращает параметры, которые не смог сохранить на сервере поставщик параметров ClientSettingsProvider.Gets the settings that the ClientSettingsProvider was unable to save to the server.

Методы

Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к

Дополнительно