Поделиться через


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

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

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

Заметка

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

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

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

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

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

См. также