ApplicationSettingsBase.SettingsKey ApplicationSettingsBase.SettingsKey ApplicationSettingsBase.SettingsKey ApplicationSettingsBase.SettingsKey Property

Определение

Возвращает или задает ключ параметров для группы параметров приложения.Gets or sets the settings key for the application settings group.

public:
 property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.Browsable(false)]
public string SettingsKey { get; set; }
member this.SettingsKey : string with get, set
Public Property SettingsKey As String

Значение свойства

String содержит ключ параметров для текущей группы параметров.A String containing the settings key for the current settings group.

Комментарии

SettingsKey Свойство предоставляется для включения клиентского кода, а в частности поставщика параметров — для устранения неоднозначности между несколькими экземплярами одного класса параметров приложения.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. Значение SettingsKey должно быть задано в соответствии с предназначением общего доступа к значениям свойств.The value of SettingsKey should be set according to how the property values are intended to be shared.

  • Если свойства параметров оболочки предназначены для совместного использования во всех экземплярах оболочки в одном приложении, то SettingsKey они должны иметь одинаковое значение во всех экземплярах.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. Это поведение ApplicationSettingsBase класса по умолчанию.This is the default behavior of the ApplicationSettingsBase class.

  • Если свойства параметров оболочки предназначены для каждого экземпляра, то SettingsKey они должны иметь уникальное значение для каждого экземпляра.If the settings properties of the wrapper are intended to be per instance, then SettingsKey should have a unique value for every instance. Версия конструктора позволяет инициализировать SettingsKey в уникальную строку. ApplicationSettingsBase(String)The ApplicationSettingsBase(String) version of the constructor enables you to initialize SettingsKey to a unique string.

Напротив, Context свойство предоставляет указания поставщику параметров, чтобы обеспечить эффективный и упорядоченный способ хранения значений.In contrast, the Context property provides hints to the settings provider to enable it to persist values in an efficient and orderly manner.

Класс содержит аналогичное SettingKey свойство, помогающее SettingChanging опознать источник события. SettingChangingEventArgsThe SettingChangingEventArgs class contains a similar SettingKey property that helps identify the source of the SettingChanging event.

Применяется к

Дополнительно