SettingsSavedEventArgs Klasse

Definition

Stellt Daten für das SettingsSaved-Ereignis bereit.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
Vererbung
SettingsSavedEventArgs

Beispiele

Im folgenden Beispielcode wird veranschaulicht, wie diese Klasse verwendet wird, um eine Liste von Einstellungen anzuzeigen, die nicht erfolgreich gespeichert wurden.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

Hinweise

Das ClientSettingsProvider.SettingsSaved Ereignis tritt auf, wenn der Einstellungs Anbieter auf den Einstellungs Dienst zugreift, auch wenn die Einstellungen nicht erfolgreich gespeichert wurden.The ClientSettingsProvider.SettingsSaved event occurs after the settings provider accesses the settings service, even if the settings were not successfully saved. Ein Grund dafür, dass der Anbieter die Einstellungen möglicherweise nicht speichert, ist, wenn der aktuelle Benutzer abgemeldet wurde. Sie können die- FailedSettingsList Eigenschaft verwenden, um zu bestimmen, ob Einstellungen nicht erfolgreich gespeichert wurden.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.

Dieses Ereignis tritt nicht auf, wenn der Einstellungs Anbieter nicht auf den Einstellungs Dienst zugreifen kann, was wiederum bewirkt, dass der Anbieter eine auslöst WebException .This event does not occur if the settings provider cannot access the settings service, which instead causes the provider to throw a WebException.

Weitere Informationen zum Behandeln von Ereignissen finden Sie unter behandeln und Auslösen von Ereignissen.For more information about how to handle events, see Handling and Raising Events.

Konstruktoren

SettingsSavedEventArgs(IEnumerable<String>)

Initialisiert eine neue Instanz der SettingsSavedEventArgs-Klasse.Initializes a new instance of the SettingsSavedEventArgs class.

Eigenschaften

FailedSettingsList

Ruft die Einstellungen ab, die von ClientSettingsProvider nicht auf dem Server gespeichert werden konnten.Gets the settings that the ClientSettingsProvider was unable to save to the server.

Methoden

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Gilt für:

Siehe auch