ClientSettingsProvider Classe

Definizione

Consente alle applicazioni basate su Windows di recuperare le impostazioni utente da un servizio delle impostazioni Web.

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
Ereditarietà
ClientSettingsProvider
Attributi
Implementazioni

Esempio

Il codice di esempio seguente illustra come usare questo evento per visualizzare un elenco di impostazioni non salvate correttamente.

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

Commenti

È possibile usare i servizi applicazione client per recuperare le impostazioni utente da un servizio impostazioni Web esistente configurando l'applicazione per usare la ClientSettingsProvider classe . Dopo la configurazione, è possibile ottenere e impostare le impostazioni utente tramite una classe di impostazioni dell'applicazione derivata da ApplicationSettingsBase e configurata per l'uso della ClientSettingsProvider classe. È possibile usare Visual Studio per generare una Settings classe per il progetto (accessibile come Properties.Settings.Default in C# e My.Settings in Visual Basic). Per altre informazioni sulle impostazioni dell'applicazione, vedere Cenni preliminari sulle impostazioni delle applicazioni.

È possibile recuperare l'oggetto corrente ClientSettingsProvider tramite la ApplicationSettingsBase.Providers proprietà usando il ClientSettingsProvider nome completo della classe come chiave. È anche possibile recuperare il provider tramite la SettingsLoadedEventArgs.Provider proprietà quando si gestisce l'evento ApplicationSettingsBase.SettingsLoaded .

Nota

Questa classe contiene un SecurityCriticalAttribute oggetto a livello di classe che si applica a tutti i membri della classe. Viene generata un'eccezione di runtime se il chiamante immediato è trasparente o parzialmente attendibile. Per altre informazioni sui tipi e i membri critici per la sicurezza, vedere Security-Transparent Code, Livello 2.

Nota

Questa classe contiene una richiesta di ereditarietà a livello di classe che si applica a tutti i membri. Viene SecurityException generato quando la classe derivata non dispone dell'autorizzazione di attendibilità completa. Per informazioni dettagliate sulle richieste di sicurezza, vedere Collegare richieste e richieste di ereditarietà.

Costruttori

ClientSettingsProvider()

Inizializza una nuova istanza della classe ClientSettingsProvider.

Proprietà

ApplicationName

Questa proprietà non viene usata da questa classe.

Description

Ottiene una breve descrizione di facile comprensione che è possibile visualizzare in strumenti di amministrazione o in altre interfacce utente (UI, User Interface).

(Ereditato da ProviderBase)
Name

Ottiene il nome descrittivo utilizzato per fare riferimento al provider durante la configurazione.

(Ereditato da ProviderBase)
ServiceUri

Ottiene o imposta il percorso del servizio delle impostazioni Web.

Metodi

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.

(Ereditato da Object)
GetHashCode()

Funge da funzione hash predefinita.

(Ereditato da Object)
GetPreviousVersion(SettingsContext, SettingsProperty)

Ottiene la versione precedente della proprietà specificata.

GetPropertyMetadata(String)

Ottiene un insieme di metadati per tutte le proprietà recuperate dal servizio delle impostazioni Web specificato.

GetPropertyValues(SettingsContext, SettingsPropertyCollection)

Restituisce l'insieme di valori delle proprietà delle impostazioni per l'istanza dell'applicazione specificata e per il gruppo di proprietà delle impostazioni.

GetType()

Ottiene l'oggetto Type dell'istanza corrente.

(Ereditato da Object)
Initialize(String, NameValueCollection)

Inizializza il provider.

MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.

(Ereditato da Object)
Reset(SettingsContext)

Reimposta tutte le impostazioni utente sui valori predefiniti.

SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

Imposta i valori del gruppo specificato di impostazioni delle proprietà.

ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.

(Ereditato da Object)
Upgrade(SettingsContext, SettingsPropertyCollection)

Questo metodo non viene utilizzato da questa classe.

Eventi

SettingsSaved

Si verifica dopo il tentativo del provider di impostazioni di salvare i valori della proprietà nel servizio delle impostazioni Web.

Si applica a

Vedi anche