ApplicationSettingsBase.SettingsKey Свойство

Определение

Пространство имен:

System.Configuration

Сборка:

System.Configuration.ConfigurationManager.dll

Пакет:

System.Configuration.ConfigurationManager v8.0.0

Исходный код:

ApplicationSettingsBase.cs

Возвращает или задает ключ параметров для группы параметров приложения.

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

String содержит ключ параметров для текущей группы параметров.

Атрибуты

BrowsableAttribute

Комментарии

Свойство SettingsKey предоставляется для включения клиентского кода и, в частности, поставщика параметров, для устранения неоднозначности между несколькими экземплярами одного класса параметров приложения.

Если класс-оболочка параметров не разработан с использованием одноэлементного шаблона, в одном приложении может быть несколько экземпляров одного и того же класса параметров приложения. Значение должно быть задано SettingsKey в соответствии с тем, как значения свойств предназначены для совместного использования.

• Если свойства параметров оболочки предназначены для совместного использования во всех экземплярах оболочки в одном приложении, то SettingsKey во всех экземплярах должно быть одинаковое значение. Это поведение класса по умолчанию ApplicationSettingsBase .

• Если свойства параметров оболочки предназначены для каждого экземпляра, то SettingsKey для каждого экземпляра должно быть уникальное значение. Версия ApplicationSettingsBase(String) конструктора позволяет инициализировать SettingsKey в уникальной строке.

В отличие от этого, Context свойство предоставляет поставщику параметров указания, позволяющие ему сохранять значения эффективным и упорядоченным образом.

Класс SettingChangingEventArgs содержит аналогичное SettingKey свойство, которое помогает определить источник SettingChanging события.

См. также раздел

• Context
• SettingChangingEventArgs