ClientSettingsProvider Classe

Définition

Espace de noms:

System.Web.ClientServices.Providers

Assembly:

System.Web.Extensions.dll

Permet aux applications Windows d'extraire des paramètres utilisateurs d'un service de paramètres Web.

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

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

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

Public Class ClientSettingsProvider
Inherits SettingsProvider
Implements IApplicationSettingsProvider

Héritage

Object

ProviderBase

SettingsProvider

ClientSettingsProvider

Attributs

SecurityCriticalAttribute

Implémente

IApplicationSettingsProvider

Exemples

L’exemple de code suivant montre comment utiliser cet événement pour afficher une liste de paramètres qui n’ont pas été correctement enregistrés.

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

Remarques

Vous pouvez utiliser les services d’application cliente pour récupérer des paramètres utilisateur à partir d’un service de paramètres Web existant en configurant votre application pour qu’elle utilise la ClientSettingsProvider classe . Après la configuration, vous pouvez obtenir et définir des paramètres utilisateur via une classe de paramètres d’application dérivée de ApplicationSettingsBase et configurée pour utiliser la ClientSettingsProvider classe . Vous pouvez utiliser Visual Studio pour générer une Settings classe pour votre projet (accessible Properties.Settings.Default en C# et My.Settings en Visual Basic). Pour plus d'informations sur les paramètres d'application, consultez Vue d'ensemble des paramètres d'application.

Vous pouvez récupérer le actuel ClientSettingsProvider via la ApplicationSettingsBase.Providers propriété en utilisant le nom de ClientSettingsProvider classe complet comme clé. Vous pouvez également récupérer le fournisseur via la SettingsLoadedEventArgs.Provider propriété lorsque vous gérez l’événement ApplicationSettingsBase.SettingsLoaded .

Notes

Cette classe contient un SecurityCriticalAttribute au niveau de la classe qui s’applique à tous les membres de la classe. Une exception d’exécution est levée si l’appelant immédiat est transparent pour la sécurité ou partiellement approuvé. Pour plus d’informations sur les types et les membres critiques de sécurité, consultez Code transparent de sécurité, niveau 2.

Notes

Cette classe contient une demande d’héritage au niveau de la classe qui s’applique à tous les membres. Un SecurityException est levée lorsque la classe dérivée n’a pas d’autorisation de confiance totale. Pour plus d’informations sur les demandes de sécurité, consultez Demandes de lien et demandes d’héritage.

Constructeurs

ClientSettingsProvider()

Initialise une nouvelle instance de la classe ClientSettingsProvider.

Propriétés

ApplicationName	Cette propriété n'est pas utilisée par cette classe.
Description	Obtient une description brève et conviviale qui peut s'afficher dans les outils d'administration ou d'autres interfaces utilisateur. (Hérité de ProviderBase)
Name	Obtient le nom convivial qui référence le fournisseur au cours de la configuration. (Hérité de ProviderBase)
ServiceUri	Obtient ou définit l'emplacement du service des paramètres Web.

Méthodes

Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetPreviousVersion(SettingsContext, SettingsProperty)	Obtient la version précédente de la propriété spécifiée.
GetPropertyMetadata(String)	Reçoit une collection de métadonnées pour toutes les propriétés extraites du service de paramètres Web spécifié.
GetPropertyValues(SettingsContext, SettingsPropertyCollection)	Retourne la collection de valeurs de propriétés de paramètres pour l'instance d'application et le groupe de propriétés de paramètres spécifiés.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
Initialize(String, NameValueCollection)	Initialise le fournisseur.
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
Reset(SettingsContext)	Rétablit tous les paramètres d'utilisateurs à leurs valeurs par défaut.
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)	Définit les valeurs du groupe de paramètres de propriétés spécifié.
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)
Upgrade(SettingsContext, SettingsPropertyCollection)	Cette méthode n'est pas utilisée par cette classe.

Événements

SettingsSaved

Se produit après que le fournisseur de paramètres ait tenté d'enregistrer les valeurs de propriété sur le service de paramètres Web.

Voir aussi

• Providers
• SettingsLoaded
• Services d'application cliente
• Vue d'ensemble des paramètres d'application
• Procédure : créer des paramètres d’application