SettingsProvider SettingsProvider SettingsProvider SettingsProvider Class

Определение

Действует как базовый класс для извлечения поставщиков пользовательских параметров в архитектуре параметров приложения.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
Наследование
SettingsProviderSettingsProviderSettingsProviderSettingsProvider
Производный

Комментарии

Поставщик параметров определяет механизм для хранения данных конфигурации, используемых в архитектуре параметров приложения.A settings provider defines the mechanism for storing configuration data used in the application settings architecture. .NET Framework содержит поставщик параметров по умолчанию единый, LocalFileSettingsProvider, который хранит данные конфигурации в локальной файловой системе.The .NET Framework contains a single default settings provider, LocalFileSettingsProvider, which stores configuration data to the local file system. Тем не менее, можно создать путем наследования от абстрактного механизмы хранения SettingsProvider класса.However, you can create alternate storage mechanisms by deriving from the abstract SettingsProvider class. Поставщик, который использует класс-оболочку определяется, дополняя класс-оболочку с SettingsProviderAttribute.The provider that a wrapper class uses is determined by decorating the wrapper class with the SettingsProviderAttribute. Если этот атрибут не задан, по умолчанию, LocalFileSettingsProvider, используется.If this attribute is not provided, the default, LocalFileSettingsProvider, is used.

Создавая настраиваемый поставщик параметров, как минимум, вы обязаны предоставлять реализацию для трех методов этого класса: GetPropertyValues, SetPropertyValues и 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.

Для клиентских приложений, можно добавить более стандартизированные функции для пользовательского поставщика путем реализации также IApplicationSettingsProvider интерфейс.For client applications, you can add more standardized functionality to a custom provider by also implementing the IApplicationSettingsProvider interface. Этот интерфейс отражает методы, найденные в ApplicationSettingsBase класс, который главным образом включает поддержку управления версиями.This interface mirrors methods found in the ApplicationSettingsBase class, which mainly enables versioning support.

Как правило следует разрабатывать поставщиков параметров в единственном экземпляре, чтобы избежать конфликта ресурсов хранилища.Typically, you should design settings providers to be single-instanced to avoid storage resource contention. Поставщики должны иметь поточно ориентированной, так как они могут быть вызваны одновременно из нескольких экземпляров программы-оболочки в одном домене приложения или из нескольких приложений в разных доменах.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.

Как минимум, поставщик параметров должен распознать три атрибута - ApplicationScopedSettingAttribute, UserScopedSettingAttribute, и DefaultSettingValueAttribute.At minimum, a settings provider must recognize three attributes - ApplicationScopedSettingAttribute, UserScopedSettingAttribute, and DefaultSettingValueAttribute. Полный список атрибутов, которые могут применяться к параметрам приложения, см. в разделе атрибуты параметров приложения.For a full listing of attributes that can be applied to application settings, see Application Settings Attributes. Поставщик пользовательских параметров должен разрешать атрибуты, примененные к свойствам параметров следующим образом:A custom setting provider should resolve attributes applied to settings properties in the following manner:

  1. Если поставщик может выполнить запрос, сделанный атрибутом, очевидно, что оно должно делать это.If the provider can fulfill the request implied by the attribute, obviously it should do so.

  2. Если поставщик не может выполнить запрос, он должен проигнорировать его.If the provider cannot fulfill the request, it should ignore it silently.

  3. Если два или несколько свойств; Например, свойство помеченное атрибутами ApplicationScopedSettingAttribute и UserScopedSettingAttribute; поставщик должен вызывать ConfigurationException.If two or more properties conflict; for example, a property being decorated with both ApplicationScopedSettingAttribute and UserScopedSettingAttribute; the provider should throw a ConfigurationException.

Конструкторы

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

Инициализирует экземпляр класса SettingsProvider.Initializes an instance of the SettingsProvider class.

Свойства

ApplicationName ApplicationName ApplicationName ApplicationName

Возвращает или задает имя работающего в данный момент приложения.Gets or sets the name of the currently running application.

Description Description Description Description

Возвращает краткое, понятное описание, подходящее для отображения в инструментах администрирования или других пользовательских интерфейсах (UI).Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Inherited from ProviderBase)
Name Name Name Name

Возвращает понятное имя, используемое для ссылки на поставщика во время конфигурирования.Gets the friendly name used to refer to the provider during configuration.

(Inherited from ProviderBase)

Методы

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

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

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

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetPropertyValues(SettingsContext, SettingsPropertyCollection) GetPropertyValues(SettingsContext, SettingsPropertyCollection) GetPropertyValues(SettingsContext, SettingsPropertyCollection) GetPropertyValues(SettingsContext, SettingsPropertyCollection)

Возвращает коллекцию значений свойства параметров для указанного экземпляра приложения и группы свойств параметров.Returns the collection of settings property values for the specified application instance and settings property group.

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

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

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

Инициализирует построитель конфигураций.Initializes the configuration builder.

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

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

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

Задает значения указанной группы параметров свойств.Sets the values of the specified group of property settings.

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

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Применяется к

Дополнительно