ClientSettingsProvider Classe

Definição

Namespace:

System.Web.ClientServices.Providers

Assembly:

System.Web.Extensions.dll

Permite que aplicativos baseados em Windows recuperem as configurações de usuário de um serviço de configurações da 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

Herança

Object

ProviderBase

SettingsProvider

ClientSettingsProvider

Atributos

SecurityCriticalAttribute

Implementações

IApplicationSettingsProvider

Exemplos

O código de exemplo a seguir demonstra como usar esse evento para exibir uma lista de configurações que não foram salvas com êxito.

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

Comentários

Você pode usar os serviços de aplicativo cliente para recuperar as configurações do usuário de um serviço de configurações da Web existente configurando seu aplicativo para usar a ClientSettingsProvider classe . Após a configuração, você pode obter e definir as configurações do usuário por meio de uma classe de configurações de aplicativo derivada e ApplicationSettingsBase configurada para usar a ClientSettingsProvider classe . Você pode usar o Visual Studio para gerar uma Settings classe para seu projeto (acessada como Properties.Settings.Default em C# e My.Settings no Visual Basic). Para obter mais informações sobre as configurações de aplicativo, consulte Visão geral sobre configurações de aplicativo.

Você pode recuperar o atual ClientSettingsProvider por meio da ApplicationSettingsBase.Providers propriedade usando o nome de classe totalmente qualificado ClientSettingsProvider como uma chave. Você também pode recuperar o provedor por meio da SettingsLoadedEventArgs.Provider propriedade ao manipular o ApplicationSettingsBase.SettingsLoaded evento.

Observação

Essa classe contém um SecurityCriticalAttribute no nível da classe que se aplica a todos os membros da classe. Uma exceção em tempo de execução será gerada se o chamador imediato for transparente de segurança ou parcialmente confiável. Para obter mais informações sobre tipos e membros críticos à segurança, consulte Código transparente de segurança, nível 2.

Observação

Essa classe contém uma demanda de herança no nível da classe que se aplica a todos os membros. Um SecurityException é gerado quando a classe derivada não tem permissão de confiança total. Para obter detalhes sobre as demandas de segurança, consulte Vincular demandas e demandas de herança.

Construtores

ClientSettingsProvider()

Inicializa uma nova instância da classe ClientSettingsProvider.

Propriedades

ApplicationName	Essa propriedade não é usada por essa classe.
Description	Obtém uma breve descrição amigável adequada para exibição em ferramentas administrativas ou outras IUs (interfaces do usuário). (Herdado de ProviderBase)
Name	Obtém o nome amigável usado para referir-se ao provedor durante a configuração. (Herdado de ProviderBase)
ServiceUri	Obtém ou define o local do serviço de configurações da Web.

Métodos

Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetPreviousVersion(SettingsContext, SettingsProperty)	Obtém a versão anterior da propriedade especificada.
GetPropertyMetadata(String)	Obtém uma coleção de metadados para todas as propriedades recuperadas do serviço de configurações da Web especificado.
GetPropertyValues(SettingsContext, SettingsPropertyCollection)	Retorna a coleção de valores da propriedade de configurações para a instância do aplicativo e o grupo de propriedades de configurações especificados.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
Initialize(String, NameValueCollection)	Inicializa o provedor.
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
Reset(SettingsContext)	Redefine todas as configurações do usuário para seus valores padrão.
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)	Define os valores do grupo especificado de configurações de propriedade.
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
Upgrade(SettingsContext, SettingsPropertyCollection)	Este método não é usado por esta classe.

Eventos

SettingsSaved

Ocorre depois que o provedor de configurações tenta salvar os valores de propriedade para o serviço de configurações da Web.

Confira também

• Providers
• SettingsLoaded
• Serviços de aplicativo cliente
• Visão geral sobre configurações do aplicativo
• Como: criar configurações de aplicativo