Show / Hide Table of Contents

Атрибуты параметров приложения

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

В следующей таблице перечислены атрибуты, которые могут применяться к классу-оболочке параметров приложения и отдельные свойства этого класса. По определению, только одну область атрибут —UserScopedSettingAttribute или ApplicationScopedSettingAttribute— должны применяться для каждого свойства параметров.

Note

Настраиваемый поставщик параметров, производным от SettingsProvider класса, требуется только для распознавания следующие три атрибута: ApplicationScopedSettingAttribute, UserScopedSettingAttribute, и DefaultSettingValueAttribute.

Атрибут целевого объекта Описание
SettingsProviderAttribute Оба Задает короткое имя поставщика параметров, используемый для сохранения состояния.

Если этот атрибут не задан, поставщик по умолчанию, LocalFileSettingsProvider, предполагается, что.
UserScopedSettingAttribute Оба Определяет свойство как параметр приложений пользователя.
ApplicationScopedSettingAttribute Оба Определяет свойство как параметр приложения.
DefaultSettingValueAttribute Свойство Указывает строку, которая может быть десериализован поставщиком жестко заданную по умолчанию для этого свойства.

LocalFileSettingsProvider Этот атрибут не требуется и переопределяет любое значение, предоставляемые этим атрибутом Если значение уже сохранены.
SettingsDescriptionAttribute Свойство Предоставляет описательный тест для отдельных параметров, в основном используется средствами времени выполнения и во время разработки.
SettingsGroupNameAttribute Класс Содержит явное имя для группы параметров. Если этот атрибут отсутствует, ApplicationSettingsBase использует имя класса-оболочки.
SettingsGroupDescriptionAttribute Класс Предоставляет описательный тест для группы параметров, в основном используется средствами времени выполнения и во время разработки.
SettingsManageabilityAttribute Оба Указывает ноль или более служб управляемости, которые должна быть представлена группа параметров или свойство. Описываются доступные службы SettingsManageability перечисления.
SpecialSettingAttribute Свойство Указывает, что параметр принадлежит к особой предопределенной категории, например строку подключения, предлагаемое специальной обработки поставщика параметров. Стандартные категории для этого атрибута определяется SpecialSetting перечисления.
SettingsSerializeAsAttribute Оба Указывает предпочтительный механизм сериализации для группы параметров или свойства. Доступные механизмы сериализации определяются SettingsSerializeAs перечисления.
NoSettingsVersionUpgradeAttribute Свойство Указывает, что поставщик параметров должен отключить всю функциональность обновления приложения для помеченного свойства.

Класс указывает, что атрибут может применяться только к классу-оболочке параметров приложения. Свойство указывает, что атрибут может быть применен только к свойствам параметров. Оба указывает, что атрибут может применяться на любом уровне.

См. также

  • ApplicationSettingsBase
  • SettingsProvider
  • Архитектура параметров приложения
  • Практическое руководство. Создание параметров приложения
Back to top Неофициальная документация по .NET на русском языке. Лицензия: CC-BY 4.0. Основано на документации по .NET с Microsoft Docs
Generated by DocFX