ClientSettingsProvider Clase

  • Referencia

Definición

Espacio de nombres:
System.Web.ClientServices.Providers
Ensamblado:
System.Web.Extensions.dll

Permite que las aplicaciones basadas en Windows recuperen los valores de usuario de un servicio de configuración 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
Herencia
Object
ProviderBase
SettingsProvider
ClientSettingsProvider
Atributos
SecurityCriticalAttribute
Implementaciones
IApplicationSettingsProvider

Ejemplos

En el código de ejemplo siguiente se muestra cómo usar este evento para mostrar una lista de configuraciones que no se guardaron correctamente.

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

Comentarios

Puede usar los servicios de aplicación cliente para recuperar la configuración de usuario de un servicio de configuración web existente mediante la configuración de la aplicación para usar la ClientSettingsProvider clase . Después de la configuración, puede obtener y establecer la configuración del usuario a través de una clase de configuración de aplicación derivada de ApplicationSettingsBase y configurada para usar la ClientSettingsProvider clase . Puede usar Visual Studio para generar una Settings clase para el proyecto (a la que se accede como Properties.Settings.Default en C# y My.Settings en Visual Basic). Para más información sobre la configuración de la aplicación, consulte Introducción a la configuración de la aplicación.

Puede recuperar el actual ClientSettingsProvider a través de la ApplicationSettingsBase.Providers propiedad mediante el nombre de clase completo ClientSettingsProvider como clave. También puede recuperar el proveedor a través de la SettingsLoadedEventArgs.Provider propiedad al controlar el ApplicationSettingsBase.SettingsLoaded evento.

Nota

Esta clase contiene un SecurityCriticalAttribute objeto en el nivel de clase que se aplica a todos los miembros de la clase . Se produce una excepción en tiempo de ejecución si el llamador inmediato es transparente o de confianza parcial. Para obtener más información sobre los tipos y miembros críticos para la seguridad, vea Código transparente de seguridad, nivel 2.

Nota

Esta clase contiene una demanda de herencia en el nivel de clase que se aplica a todos los miembros. Se SecurityException produce una excepción cuando la clase derivada no tiene permiso de plena confianza. Para obtener más información sobre las demandas de seguridad, consulte Demandas de vínculo y demandas de herencia.

Constructores

ClientSettingsProvider()

Inicializa una nueva instancia de la clase ClientSettingsProvider.

Propiedades

ApplicationName

Esta propiedad no se usa en esta clase.
Description

Obtiene una descripción breve y fácil de comprender apropiada para mostrarla en las herramientas administrativas u otras interfaces de usuario.

(Heredado de ProviderBase)
Name

Obtiene el nombre descriptivo utilizado para hacer referencia al proveedor durante la configuración.

(Heredado de ProviderBase)
ServiceUri

Obtiene o establece la ubicación del servicio de configuración web.

Métodos

Equals(Object)

Determina si el objeto especificado es igual que el objeto actual.

(Heredado de Object)
GetHashCode()

Sirve como la función hash predeterminada.

(Heredado de Object)
GetPreviousVersion(SettingsContext, SettingsProperty)

Obtiene la versión anterior de la propiedad especificada.
GetPropertyMetadata(String)

Obtiene una colección de metadatos para todas las propiedades recuperadas del servicio de configuración web especificado.
GetPropertyValues(SettingsContext, SettingsPropertyCollection)

Devuelve la colección de valores de propiedades de configuración para la instancia de la aplicación y el grupo de propiedades de configuración especificados.
GetType()

Obtiene el Type de la instancia actual.

(Heredado de Object)
Initialize(String, NameValueCollection)

Inicializa el proveedor.
MemberwiseClone()

Crea una copia superficial del Object actual.

(Heredado de Object)
Reset(SettingsContext)

Restablece toda configuración del usuario a sus valores predeterminados.
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

Establece los valores del grupo especificado de valores de propiedades.
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Object)
Upgrade(SettingsContext, SettingsPropertyCollection)

Este método no se usa en esta clase.

Eventos

SettingsSaved

Se produce después de que el proveedor de configuración intenta guardar los valores de la propiedad en el servicio de configuración web.

Se aplica a

Consulte también