SettingsProvider SettingsProvider SettingsProvider SettingsProvider Class

Definición

Actúa como una clase base para derivar los proveedores de configuración personalizados de la arquitectura de configuración de aplicación.Acts as a base class for deriving custom settings providers in the application settings architecture.

public ref class SettingsProvider abstract : System::Configuration::Provider::ProviderBase
public abstract class SettingsProvider : System.Configuration.Provider.ProviderBase
type SettingsProvider = class
    inherit ProviderBase
Public MustInherit Class SettingsProvider
Inherits ProviderBase
Herencia
SettingsProviderSettingsProviderSettingsProviderSettingsProvider
Derivado

Comentarios

Un proveedor de configuración define el mecanismo para almacenar los datos de configuración que se usan en la arquitectura de configuración de la aplicación.A settings provider defines the mechanism for storing configuration data used in the application settings architecture. El .NET Framework contiene un proveedor de configuración predeterminado único LocalFileSettingsProvider,, que almacena los datos de configuración en el sistema de archivos local.The .NET Framework contains a single default settings provider, LocalFileSettingsProvider, which stores configuration data to the local file system. Sin embargo, puede crear mecanismos de almacenamiento alternativos derivando de la clase SettingsProvider abstracta.However, you can create alternate storage mechanisms by deriving from the abstract SettingsProvider class. El proveedor que usa una clase contenedora se determina mediante la decoración de la clase SettingsProviderAttributecontenedora con.The provider that a wrapper class uses is determined by decorating the wrapper class with the SettingsProviderAttribute. Si no se proporciona este atributo, se utiliza el LocalFileSettingsProvidervalor predeterminado,,.If this attribute is not provided, the default, LocalFileSettingsProvider, is used.

Al crear un proveedor de configuración personalizado, debe proporcionar, como mínimo, implementaciones para los tres métodos de esta clase: GetPropertyValues, SetPropertyValues y ApplicationName.When you create a custom settings provider, at minimum, you must provide implementations for the three methods of this class: GetPropertyValues, SetPropertyValues and ApplicationName.

En el caso de las aplicaciones cliente, puede agregar más funcionalidad estandarizada a un proveedor personalizado IApplicationSettingsProvider implementando también la interfaz.For client applications, you can add more standardized functionality to a custom provider by also implementing the IApplicationSettingsProvider interface. Esta interfaz refleja los métodos que se ApplicationSettingsBase encuentran en la clase, lo que habilita principalmente la compatibilidad con el control de versiones.This interface mirrors methods found in the ApplicationSettingsBase class, which mainly enables versioning support.

Normalmente, debe diseñar los proveedores de configuración para que sean de instancia única para evitar la contención de recursos de almacenamiento.Typically, you should design settings providers to be single-instanced to avoid storage resource contention. Los proveedores también deben ser seguros para subprocesos porque se pueden llamar a la vez desde varias instancias de contenedor en un dominio de aplicación único o desde varias aplicaciones en dominios diferentes.Providers should also be thread-safe because they can be called simultaneously from multiple wrapper instances in a single application domain or from multiple applications in different domains.

Como mínimo, un proveedor de configuración debe reconocer tres atributos ApplicationScopedSettingAttribute: UserScopedSettingAttribute, y DefaultSettingValueAttribute.At minimum, a settings provider must recognize three attributes - ApplicationScopedSettingAttribute, UserScopedSettingAttribute, and DefaultSettingValueAttribute. Para obtener una lista completa de los atributos que se pueden aplicar a la configuración de la aplicación, consulte atributos de configuraciónde la aplicación.For a full listing of attributes that can be applied to application settings, see Application Settings Attributes. Un proveedor de configuración personalizada debe resolver los atributos aplicados a las propiedades de configuración de la siguiente manera:A custom setting provider should resolve attributes applied to settings properties in the following manner:

  1. Si el proveedor puede cumplir la solicitud implícita por el atributo, obviamente debería hacerlo.If the provider can fulfill the request implied by the attribute, obviously it should do so.

  2. Si el proveedor no puede cumplir la solicitud, debe omitirse de forma silenciosa.If the provider cannot fulfill the request, it should ignore it silently.

  3. Si dos o más propiedades están en conflicto; por ejemplo, una propiedad que se decora con ApplicationScopedSettingAttribute y UserScopedSettingAttribute; el proveedor debe iniciar una ConfigurationExceptionexcepción.If two or more properties conflict; for example, a property being decorated with both ApplicationScopedSettingAttribute and UserScopedSettingAttribute; the provider should throw a ConfigurationException.

Constructores

SettingsProvider() SettingsProvider() SettingsProvider() SettingsProvider()

Inicializa una instancia de la clase SettingsProvider.Initializes an instance of the SettingsProvider class.

Propiedades

ApplicationName ApplicationName ApplicationName ApplicationName

Obtiene o establece el nombre de la aplicación que se está ejecutando actualmente.Gets or sets the name of the currently running application.

Description Description Description Description

Obtiene una descripción breve y fácil de comprender apropiada para mostrarla en las herramientas administrativas u otras interfaces de usuario.Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Inherited from ProviderBase)
Name Name Name Name

Obtiene el nombre descriptivo utilizado para hacer referencia al proveedor durante la configuración.Gets the friendly name used to refer to the provider during configuration.

(Inherited from ProviderBase)

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Inherited from Object)
GetPropertyValues(SettingsContext, SettingsPropertyCollection) GetPropertyValues(SettingsContext, SettingsPropertyCollection) GetPropertyValues(SettingsContext, SettingsPropertyCollection) 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.Returns the collection of settings property values for the specified application instance and settings property group.

GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection)

Inicializa el generador de configuración.Initializes the configuration builder.

(Inherited from ProviderBase)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection) SetPropertyValues(SettingsContext, SettingsPropertyValueCollection) SetPropertyValues(SettingsContext, SettingsPropertyValueCollection) SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

Establece los valores del grupo especificado de valores de propiedades.Sets the values of the specified group of property settings.

ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Se aplica a

Consulte también: