ApplicationSettingsBase.SettingsKey Property

Gets or sets the settings key for the application settings group.

Namespace: System.Configuration
Assembly: System (in system.dll)

public string SettingsKey { get; set; }
/** @property */
public String get_SettingsKey ()

/** @property */
public void set_SettingsKey (String value)

public function get SettingsKey () : String

public function set SettingsKey (value : String)

Not applicable.

Property Value

A String containing the settings key for the current settings group.

The SettingsKey property is provided to enable client code, and in particular the settings provider, to disambiguate between multiple instances of the same application settings class.

Unless the settings wrapper class is designed using the singleton pattern, there can be multiple instances of the same application settings class in a single application. The value of SettingsKey should be set according to how the property values are intended to be shared.

  • If the settings properties of the wrapper are intended to be shared across all instances of the wrapper in the same application, then SettingsKey should have the same value in all of the instances. This is the default behavior of the ApplicationSettingsBase class.

  • If the settings properties of the wrapper are intended to be per instance, then SettingsKey should have a unique value for every instance. The ApplicationSettingsBase(String) version of the constructor enables you to initialize SettingsKey to a unique string.

In contrast, the Context property provides hints to the settings provider to enable it to persist values in an efficient and orderly manner.

The SettingChangingEventArgs class contains a similar SettingKey property that helps identify the source of the SettingChanging event.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: