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

  • Статья

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

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

Примечание.

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

Атрибут Назначение Description
SettingsProviderAttribute Оба Задает короткое имя поставщика параметров, которое используется для сохраняемости.

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

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

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

См. также