ClientSettingsProvider Třída

Definice

Umožňuje aplikacím založeným na systému Windows načíst uživatelská nastavení ze služby nastavení webu.

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
Dědičnost
ClientSettingsProvider
Atributy
Implementuje

Příklady

Následující příklad kódu ukazuje, jak použít tuto událost k zobrazení seznamu nastavení, které nebyly úspěšně uloženy.

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

Poznámky

Pomocí služeb klientských aplikací můžete načíst uživatelská nastavení z existující služby nastavení webu tak, že aplikaci nakonfigurujete tak, aby používala ClientSettingsProvider třídu . Po konfiguraci můžete získat a nastavit uživatelská nastavení prostřednictvím třídy nastavení aplikace odvozené z ApplicationSettingsBase a nakonfigurované pro použití třídy ClientSettingsProvider . Pomocí sady Visual Studio můžete vygenerovat Settings třídu pro váš projekt (přístupná jako Properties.Settings.Default v jazyce C# a My.Settings Visual Basic). Další informace o nastavení aplikace najdete v tématu Přehled nastavení aplikace.

Aktuální ClientSettingsProvider můžete načíst prostřednictvím ApplicationSettingsBase.Providers vlastnosti s použitím plně kvalifikovaného ClientSettingsProvider názvu třídy jako klíče. Zprostředkovatel můžete také načíst prostřednictvím SettingsLoadedEventArgs.Provider vlastnosti při zpracování ApplicationSettingsBase.SettingsLoaded události.

Poznámka

Tato třída obsahuje na úrovni třídy objekt SecurityCriticalAttribute , který se vztahuje na všechny členy třídy . Pokud je okamžitý volající transparentní z hlediska zabezpečení nebo částečně důvěryhodný, vyvolá se výjimka za běhu. Další informace o typech a členech kritických pro zabezpečení najdete v tématu Kód transparentní z hlediska zabezpečení, úroveň 2.

Poznámka

Tato třída obsahuje požadavek dědičnosti na úrovni třídy, který platí pro všechny členy. Je SecurityException vyvolán, pokud odvozená třída nemá oprávnění úplný vztah důvěryhodnosti. Podrobnosti o požadavcích na zabezpečení najdete v tématu Propojení požadavků a Požadavků dědičnosti.

Konstruktory

ClientSettingsProvider()

Inicializuje novou instanci ClientSettingsProvider třídy .

Vlastnosti

ApplicationName

Tato vlastnost není používána touto třídou.

Description

Získá stručný popis vhodný pro zobrazení v nástrojích pro správu nebo jiných uživatelských rozhraní (UI).

(Zděděno od ProviderBase)
Name

Získá popisný název použitý k odkaz na zprostředkovatele během konfigurace.

(Zděděno od ProviderBase)
ServiceUri

Získá nebo nastaví umístění služby nastavení webu.

Metody

Equals(Object)

Určí, zda se zadaný objekt rovná aktuálnímu objektu.

(Zděděno od Object)
GetHashCode()

Slouží jako výchozí hashovací funkce.

(Zděděno od Object)
GetPreviousVersion(SettingsContext, SettingsProperty)

Získá předchozí verzi zadané vlastnosti.

GetPropertyMetadata(String)

Získá kolekci metadat pro všechny vlastnosti načtené ze zadané služby nastavení webu.

GetPropertyValues(SettingsContext, SettingsPropertyCollection)

Vrátí kolekci hodnot vlastností nastavení pro zadanou instanci aplikace a skupinu vlastností nastavení.

GetType()

Type Získá z aktuální instance.

(Zděděno od Object)
Initialize(String, NameValueCollection)

Inicializuje zprostředkovatele.

MemberwiseClone()

Vytvoří mělkou kopii aktuálního Objectsouboru .

(Zděděno od Object)
Reset(SettingsContext)

Obnoví všechna uživatelská nastavení na výchozí hodnoty.

SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

Nastaví hodnoty zadané skupiny nastavení vlastností.

ToString()

Vrátí řetězec, který představuje aktuální objekt.

(Zděděno od Object)
Upgrade(SettingsContext, SettingsPropertyCollection)

Tato metoda není používána touto třídou.

Událost

SettingsSaved

Vyvolá se poté, co se zprostředkovatel nastavení pokusí uložit hodnoty vlastností do služby nastavení webu.

Platí pro

Viz také