SettingsProvider Класс

  • Ссылка

Определение

Пространство имен:
System.Configuration
Сборка:
System.Configuration.ConfigurationManager.dll
Сборка:
System.dll
Пакет:
System.Configuration.ConfigurationManager v6.0.0
Пакет:
System.Configuration.ConfigurationManager v7.0.0
Пакет:
System.Configuration.ConfigurationManager v8.0.0
Пакет:
System.Configuration.ConfigurationManager v9.0.0-preview.2.24128.5
Исходный код:
SettingsProvider.cs
Исходный код:
SettingsProvider.cs
Исходный код:
SettingsProvider.cs

Действует как базовый класс для извлечения поставщиков пользовательских параметров в архитектуре параметров приложения.

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
Наследование
Object
ProviderBase
SettingsProvider
Производный

Комментарии

Поставщик параметров определяет механизм хранения данных конфигурации, используемых в архитектуре параметров приложения. Платформа .NET Framework содержит один поставщик параметров по умолчанию , LocalFileSettingsProviderкоторый хранит данные конфигурации в локальной файловой системе. Однако можно создать альтернативные механизмы хранения, производные от абстрактного SettingsProvider класса. Поставщик, который использует класс-оболочка, определяется путем декорирования класса-оболочки SettingsProviderAttributeс помощью . Если этот атрибут не указан, используется значение по умолчанию LocalFileSettingsProvider, .

При создании настраиваемого поставщика параметров необходимо как минимум предоставить реализации для трех методов этого класса: GetPropertyValues, SetPropertyValues и ApplicationName.

Для клиентских приложений можно добавить дополнительные стандартизированные функции к пользовательскому поставщику, также реализовав IApplicationSettingsProvider интерфейс . Этот интерфейс отражает методы, найденные ApplicationSettingsBase в классе , который в основном обеспечивает поддержку управления версиями.

Как правило, поставщики параметров разработки должны быть одним экземпляром, чтобы избежать состязания за ресурсы хранилища. Поставщики также должны быть потокобезопасными, так как их можно вызывать одновременно из нескольких экземпляров оболочки в одном домене приложения или из нескольких приложений в разных доменах.

Как минимум, поставщик параметров должен распознавать три атрибута : ApplicationScopedSettingAttribute, UserScopedSettingAttributeи DefaultSettingValueAttribute. Полный список атрибутов, которые можно применить к параметрам приложения, см. в разделе Атрибуты параметров приложения. Поставщик настраиваемых параметров должен разрешать атрибуты, применяемые к свойствам параметров, следующим образом:

  1. Если поставщик может выполнить запрос, подразумеваемый атрибутом , очевидно, он должен это сделать.

  2. Если поставщик не может выполнить запрос, он должен игнорировать его без уведомления.

  3. Если два или более свойств конфликтуют; Например, свойство, декорированное как , так ApplicationScopedSettingAttribute и UserScopedSettingAttribute; поставщик должен вызвать исключение ConfigurationException.

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

SettingsProvider()

Инициализирует экземпляр класса SettingsProvider.

Свойства

ApplicationName

Возвращает или задает имя работающего в данный момент приложения.
Description

Возвращает краткое, понятное описание, подходящее для отображения в инструментах администрирования или других пользовательских интерфейсах (UI).

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

Возвращает понятное имя, используемое для ссылки на поставщика во время конфигурирования.

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

Методы

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

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

Служит хэш-функцией по умолчанию.

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

Возвращает коллекцию значений свойства параметров для указанного экземпляра приложения и группы свойств параметров.
GetType()

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

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

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

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

Создает неполную копию текущего объекта Object.

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

Задает значения указанной группы параметров свойств.
ToString()

Возвращает строку, представляющую текущий объект.

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

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

См. также раздел