ClientSettingsProvider Klasse

Referenz

Definition

Namespace:: System.Web.ClientServices.Providers

Assembly:: System.Web.Extensions.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Aktiviert Anwendungen, die auf Windows basieren, für den Abruf von Benutzereinstellungen von einem Webeinstellungsdienst.

public ref class ClientSettingsProvider : System::Configuration::SettingsProvider, System::Configuration::IApplicationSettingsProvider

public class ClientSettingsProvider : System.Configuration.SettingsProvider, System.Configuration.IApplicationSettingsProvider

[System.Security.SecurityCritical]
public class ClientSettingsProvider : System.Configuration.SettingsProvider, System.Configuration.IApplicationSettingsProvider

type ClientSettingsProvider = class
    inherit SettingsProvider
    interface IApplicationSettingsProvider

[<System.Security.SecurityCritical>]
type ClientSettingsProvider = class
    inherit SettingsProvider
    interface IApplicationSettingsProvider

Public Class ClientSettingsProvider
Inherits SettingsProvider
Implements IApplicationSettingsProvider

Vererbung: Object

ProviderBase

SettingsProvider
ClientSettingsProvider

Attribute: SecurityCriticalAttribute

Implementiert: IApplicationSettingsProvider

Beispiele

Der folgende Beispielcode veranschaulicht, wie dieses Ereignis verwendet wird, um eine Liste von Einstellungen anzuzeigen, die nicht erfolgreich gespeichert wurden.

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

Sie können Clientanwendungsdienste verwenden, um Benutzereinstellungen aus einem vorhandenen Webdienst abzurufen, indem Sie Ihre Anwendung für die Verwendung der ClientSettingsProvider -Klasse konfigurieren. Nach der Konfiguration können Sie Benutzereinstellungen über eine Anwendungseinstellungsklasse abrufen und festlegen, die von ApplicationSettingsBase abgeleitet und für die Verwendung der ClientSettingsProvider -Klasse konfiguriert wurde. Sie können Visual Studio verwenden, um eine Settings Klasse für Ihr Projekt zu generieren (zugriff wie Properties.Settings.Default in C# und My.Settings in Visual Basic). Weitere Informationen zu Anwendungseinstellungen finden Sie unter Übersicht über Anwendungseinstellungen.

Sie können den aktuellen über die ApplicationSettingsBase.Providers -Eigenschaft abrufen, indem Sie den vollqualifizierten ClientSettingsProvider ClientSettingsProvider Klassennamen als Schlüssel verwenden. Sie können den Anbieter auch über die SettingsLoadedEventArgs.Provider -Eigenschaft abrufen, wenn Sie das ApplicationSettingsBase.SettingsLoaded Ereignis behandeln.

Hinweis

Diese Klasse enthält ein SecurityCriticalAttribute auf Klassenebene, das für alle Member der Klasse gilt. Eine Laufzeitausnahme wird ausgelöst, wenn der sofortige Aufrufer sicherheitstransparent oder teilweise vertrauenswürdig ist. Weitere Informationen zu sicherheitskritischen Typen und Membern finden Sie unter Sicherheitstransparenten Code, Ebene 2.

Hinweis

Diese Klasse enthält eine Vererbungsanforderung auf Klassenebene, die für alle Member gilt. Ein SecurityException wird ausgelöst, wenn die abgeleitete Klasse nicht über voll vertrauenswürdige Berechtigungen verfügt. Ausführliche Informationen zu Sicherheitsanforderungen finden Sie unter Linkanforderungen und Vererbungsanforderungen.

Konstruktoren

ClientSettingsProvider()

Initialisiert eine neue Instanz der ClientSettingsProvider-Klasse.

Eigenschaften

ApplicationName	Diese Eigenschaft wird von dieser Klasse nicht verwendet.
Description	Ruft eine kurze, benutzerfreundliche Beschreibung ab, die für die Anzeige in Verwaltungstools oder anderen Benutzeroberflächen geeignet ist. (Geerbt von ProviderBase)
Name	Ruft den Anzeigennamen ab, der verwendet wird, um während der Konfiguration auf den Anbieter zu verweisen. (Geerbt von ProviderBase)
ServiceUri	Ruft den Speicherort des Webeinstellungsdiensts ab oder legt diesen fest.

Methoden

Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetPreviousVersion(SettingsContext, SettingsProperty)	Ruft die vorherige Version der angegebenen Eigenschaft ab.
GetPropertyMetadata(String)	Ruft eine Auflistung von Metadaten für alle Eigenschaften ab, die vom angegebenen Webeinstellungsdienst abgerufen werden.
GetPropertyValues(SettingsContext, SettingsPropertyCollection)	Gibt die Auflistung der Einstellungseigenschaftswerte für die angegebene Anwendungsinstanz und Einstellungseigenschaftengruppe zurück.
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
Initialize(String, NameValueCollection)	Initialisiert den Anbieter.
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
Reset(SettingsContext)	Setzt alle Benutzereinstellungen auf ihre Standardwerte zurück.
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)	Legt die Werte der angegebenen Gruppe von Eigenschafteneinstellungen fest.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)
Upgrade(SettingsContext, SettingsPropertyCollection)	Diese Methode wird von dieser Klasse nicht verwendet.

Ereignisse

SettingsSaved

Tritt auf, nachdem der Einstellungsanbieter versucht, die Eigenschaftswerte im Webeinstellungsdienst zu speichern.

Gilt für: