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 。