SettingsProvider 类

定义

命名空间:

System.Configuration

程序集:

System.Configuration.ConfigurationManager.dll

包:

System.Configuration.ConfigurationManager v8.0.0

Source:

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

派生

System.Configuration.LocalFileSettingsProvider

System.Web.ClientServices.Providers.ClientSettingsProvider

System.Web.Profile.ProfileProvider

注解

设置提供程序定义用于存储应用程序设置体系结构中使用的配置数据的机制。 .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)

另请参阅

• IApplicationSettingsProvider
• LocalFileSettingsProvider
• SettingsProviderAttribute
• ApplicationSettingsBase
• ConfigurationException
• 应用程序设置体系结构
• 应用程序设置特性