ApplicationSettingsBase.SettingsKey 属性
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
获取或设置应用程序设置组的设置键。
public:
property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.Browsable(false)]
public string SettingsKey { get; set; }
[<System.ComponentModel.Browsable(false)>]
member this.SettingsKey : string with get, set
Public Property SettingsKey As String
属性值
一个 String,包含当前设置组的设置键。
- 属性
注解
SettingsKey提供 属性以使客户端代码(尤其是设置提供程序)能够消除同一应用程序设置类的多个实例之间的歧义。
除非设置包装类是使用单一实例模式设计的,否则在单个应用程序中可以有多个同一应用程序设置类的实例。 SettingsKey的值应根据属性值的共享方式进行设置。
如果包装的设置属性旨在在同一应用程序中的所有包装器实例之间共享,则 SettingsKey 在所有实例中应具有相同的值。 这是 类的默认行为 ApplicationSettingsBase 。
如果包装器的设置属性应针对每个实例,则应 SettingsKey 为每个实例提供唯一值。 使用 ApplicationSettingsBase(String) 构造函数的版本可以初始化 SettingsKey 为唯一字符串。
相反, Context 属性向设置提供程序提供提示,使其能够以高效有序的方式保存值。
类 SettingChangingEventArgs 包含一个类似的 SettingKey 属性,该属性可帮助标识事件的源 SettingChanging 。