ClientSettingsProvider Classe

Definição

Permite que aplicações baseadas em Windows recuperem as definições de utilizador de um serviço de definições 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
Herança
ClientSettingsProvider
Atributos
Implementações

Exemplos

O código de exemplo seguinte demonstra como usar este evento para mostrar uma lista de definições que não foram guardadas com sucesso.

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

Observações

Pode usar serviços de aplicação cliente para recuperar definições de utilizador de um serviço de definições Web existente, configurando a sua aplicação para usar a ClientSettingsProvider classe. Após a configuração, pode obter e definir definições de utilizador através de uma classe de definições de aplicação derivada e ApplicationSettingsBase configurada para usar a ClientSettingsProvider classe. Podes usar Visual Studio para gerar uma classe Settings para o teu projeto (acedida como Properties.Settings.Default em C# e My.Settings em Visual Basic). Para mais informações sobre as definições da aplicação, consulte Visão Geral das Definições da Aplicação.

Pode recuperar a corrente ClientSettingsProvider através da ApplicationSettingsBase.Providers propriedade usando o nome da classe totalmente qualificada ClientSettingsProvider como chave. Também pode recuperar o prestador através da SettingsLoadedEventArgs.Provider propriedade quando tratar do ApplicationSettingsBase.SettingsLoaded evento.

Note

Esta classe contém a SecurityCriticalAttribute ao nível da classe que se aplica a todos os membros da classe. Uma exceção em tempo de execução é lançada se o chamador imediato for transparente em termos de segurança ou parcialmente confiável. Para mais informações sobre tipos e membros críticos para a segurança, consulte Security-Transparent Código, Nível 2.

Note

Esta classe contém uma exigência de herança ao nível da classe que se aplica a todos os membros. A SecurityException é lançado quando a classe derivada não tem permissão de confiança total. Para detalhes sobre exigências de segurança, consulte Exigências de Ligação e Exigências de Herança.

Construtores

Name Description
ClientSettingsProvider()

Inicializa uma nova instância da ClientSettingsProvider classe.

Propriedades

Name Description
ApplicationName

Esta propriedade não é utilizada por esta classe.

Description

Recebe uma descrição breve e amigável, adequada para exibição em ferramentas administrativas ou outras interfaces de utilizador (UIs).

(Herdado de ProviderBase)
Name

Recebe o nome amigável usado para se referir ao fornecedor durante a configuração.

(Herdado de ProviderBase)
ServiceUri

Obtém ou define a localização do serviço de definições Web.

Métodos

Name Description
Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetHashCode()

Serve como função de hash predefinida.

(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 definições Web especificado.

GetPropertyValues(SettingsContext, SettingsPropertyCollection)

Devolve a coleção de valores de propriedades de definições para a instância de aplicação especificada e o grupo de propriedades de definições.

GetType()

Obtém o Type da instância atual.

(Herdado de Object)
Initialize(String, NameValueCollection)

Inicializa o fornecedor.

MemberwiseClone()

Cria uma cópia superficial do atual Object.

(Herdado de Object)
Reset(SettingsContext)

Reinicia todas as definições do utilizador para os valores predefinidos.

SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

Define os valores do grupo especificado de definições de propriedades.

ToString()

Devolve uma cadeia que representa o objeto atual.

(Herdado de Object)
Upgrade(SettingsContext, SettingsPropertyCollection)

Este método não é utilizado por esta classe.

evento

Name Description
SettingsSaved

Ocorre depois de o fornecedor de definições tentar guardar os valores das propriedades no serviço de definições Web.

Aplica-se a

Ver também