IPersistComponentSettings.SettingsKey 属性

定义

命名空间:

System.Configuration

程序集:

System.Configuration.ConfigurationManager.dll

包:

System.Configuration.ConfigurationManager v8.0.0

Source:

IPersistComponentSettings.cs

获取或设置控件当前实例的应用程序设置键的值。

public:
 property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };

public string SettingsKey { get; set; }

member this.SettingsKey : string with get, set

Public Property SettingsKey As String

属性值

String

一个 String，包含该控件的当前实例的设置键。

注解

SettingsKey当同一包装类有多个实例时，使用 属性消除应用程序设置属性组的歧义。 例如，如果控件包含关联的包装类，则在同一应用程序中放置同一控件的多个实例通常会导致包装类的多个实例。 仅当每个实例的配置数据不同时，才需要设置密钥;例如，动态定位控件的位置。

以下一般规则适用于 的使用 SettingsKey：

• 与任何类一样，控件可能包含派生自 ApplicationSettingsBase的零个或多个应用程序设置类。 每个设置类都包含其自己的 ApplicationSettingsBase.SettingsKey 属性，这有助于消除该类的多个实例的歧义。

• 控件应将其每个实例数据和共享数据分离到不同的设置类中。

• 对于具有任何每个实例配置数据的控件， get 属性的访问 SettingsKey 器应默认为 Name 控件的 。 在大多数情况下，控件的名称在应用程序中是唯一的。 如果控件仅包含共享配置数据， get 应默认为 null。

• set应实现此属性的访问器，以区分包含每个实例和共享配置数据的设置类。 对于包含每个实例数据的每个设置类， set 应仅传递到 ApplicationSettingsBase.SettingsKey 设置类的 属性。 对于包含共享数据的设置类， set 不应对该设置类执行任何操作。

另请参阅

• SaveComponentSettings()
• SettingsKey
• 自定义控件的应用程序设置