SettingsProvider Класс

Определение

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

Комментарии

Поставщик параметров определяет механизм хранения данных конфигурации, используемых в архитектуре параметров приложения.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.Initializes an instance of the SettingsProvider class.

Свойства

ApplicationName

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

Description

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

(Унаследовано от ProviderBase)
Name

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

(Унаследовано от ProviderBase)

Методы

Equals(Object)

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

(Унаследовано от Object)
GetHashCode()

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

(Унаследовано от Object)
GetPropertyValues(SettingsContext, SettingsPropertyCollection)

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

GetType()

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

(Унаследовано от Object)
Initialize(String, NameValueCollection)

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

(Унаследовано от ProviderBase)
MemberwiseClone()

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

(Унаследовано от Object)
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

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

ToString()

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

(Унаследовано от Object)

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

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