应用程序设置属性

应用程序设置体系结构提供了许多属性,这些属性可以应用于应用程序设置包装器类或其各个属性。 应用程序设置基础结构(通常是设置提供程序)在运行时检查这些属性,以便根据自定义包装器的状态需求定制其功能。

下表列出了可以应用于应用程序设置包装类、该类的各个属性或两者的属性。 根据定义,必须仅将单个范围属性(UserScopedSettingAttributeApplicationScopedSettingAttribute)应用于每个设置属性。

注释

SettingsProvider 类派生的自定义设置提供程序只需要识别以下三个属性:ApplicationScopedSettingAttributeUserScopedSettingAttributeDefaultSettingValueAttribute

特征 目标 DESCRIPTION
SettingsProviderAttribute 两者 指定要用于持久性的设置提供程序的短名称。

如果未提供此属性,则假定默认提供程序 LocalFileSettingsProvider
UserScopedSettingAttribute 两者 将属性定义为用户范围的应用程序设置。
ApplicationScopedSettingAttribute 两者 将属性定义为应用程序范围内的应用程序设置。
DefaultSettingValueAttribute 资产 指定一个字符串,该字符串可由提供程序反序列化为此属性的硬编码默认值。

LocalFileSettingsProvider 不需要此属性的值,并且如果已经存在保存的值,将覆盖此属性提供的任何值。
SettingsDescriptionAttribute 资产 提供单个设置的描述性测试,主要由运行时和设计时工具使用。
SettingsGroupNameAttribute 班级 为设置组提供显式名称。 如果缺少此属性,ApplicationSettingsBase 将使用包装器类名称。
SettingsGroupDescriptionAttribute 班级 提供设置组的描述性测试,主要由运行时和设计时工具使用。
SettingsManageabilityAttribute 两者 指定应提供给设置组或属性的零个或多个可管理性服务。 可用服务由 SettingsManageability 枚举描述。
SpecialSettingAttribute 资产 表明某个设置属于一个特殊的预定义类别,例如连接字符串,意味着设置提供者会对其执行特定的处理。 此属性的预定义类别由 SpecialSetting 枚举定义。
SettingsSerializeAsAttribute 两者 指定设置组或属性的首选序列化机制。 可用的序列化机制由 SettingsSerializeAs 枚举定义。
NoSettingsVersionUpgradeAttribute 资产 指定设置供应商应禁用标记属性的所有应用程序升级功能。

指示该属性只能应用于应用程序设置包装类。 Property 表示该属性只能用于设置属性。 两者 都表示可以在任一级别应用该属性。

另请参阅