IPersistComponentSettings.SettingsKey Свойство

Определение

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

System.Configuration

Сборка:

System.Configuration.ConfigurationManager.dll

Пакет:

System.Configuration.ConfigurationManager v8.0.0

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

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. Каждый класс settings содержит собственное ApplicationSettingsBase.SettingsKey свойство, которое помогает устранить неоднозначности нескольких экземпляров этого класса.

• Элемент управления должен разделять свои данные по экземпляру и общие данные на разные классы параметров.

• Для элемента управления с любыми данными конфигурации для каждого экземпляра getSettingsKey метод доступа свойства должен по умолчанию иметь Name значение элемента управления . В большинстве случаев имя элемента управления будет уникальным в пределах приложения. Если элемент управления содержит только общие данные конфигурации, get по умолчанию должен иметь значение null.

• Метод set доступа для этого свойства должен быть реализован для различения классов параметров, содержащих данные об экземпляре, и общих данных конфигурации. Для каждого класса параметров, содержащего данные по экземпляру, set следует просто передать ApplicationSettingsBase.SettingsKey в свойство класса settings. Для классов параметров, содержащих общие данные, set не должен выполнять никаких действий для этого класса параметров.

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

• SaveComponentSettings()
• SettingsKey
• Параметры приложения для пользовательских элементов управления