Compartilhar via

Atributos de Configurações de Aplicativo

A arquitetura de Configurações de Aplicativo fornece muitos atributos que podem ser aplicados à classe wrapper de configurações de aplicativos ou às suas propriedades individuais. Esses atributos são examinados em tempo de execução pela infraestrutura de configurações do aplicativo, geralmente especificamente o provedor de configurações, a fim de adaptar seu funcionamento às necessidades declaradas do wrapper personalizado.

A tabela a seguir lista os atributos que podem ser aplicados à classe wrapper de configurações do aplicativo, às propriedades individuais dessa classe ou a ambos. Por definição, apenas um único atributo de escopo — UserScopedSettingAttribute ou ApplicationScopedSettingAttribute — deve ser aplicado a cada propriedade de configurações.

Observação

Um provedor de configurações personalizado, derivado da SettingsProvider classe, só é necessário para reconhecer os três atributos a seguir: ApplicationScopedSettingAttribute, UserScopedSettingAttribute e DefaultSettingValueAttribute.

Atributo Meta Descrição
SettingsProviderAttribute Ambos Especifica o nome curto do provedor de configurações a ser usado para persistência.

Se esse atributo não for fornecido, o provedor padrão LocalFileSettingsProviderserá assumido.
UserScopedSettingAttribute Ambos Define uma propriedade como uma configuração de aplicativo com escopo de usuário.
ApplicationScopedSettingAttribute Ambos Define uma propriedade como uma configuração de aplicativo com escopo específico.
DefaultSettingValueAttribute Propriedade Especifica uma cadeia de caracteres que pode ser desserializada pelo provedor no valor padrão codificado para essa propriedade.

O LocalFileSettingsProvider não requer esse atributo e substituirá qualquer valor fornecido por esse atributo se houver um valor já persistente.
SettingsDescriptionAttribute Propriedade Fornece o teste descritivo para um ajuste individual, usado principalmente por ferramentas de tempo de execução e de design.
SettingsGroupNameAttribute Classe Fornece um nome explícito para um grupo de configurações. Se esse atributo estiver ausente, ApplicationSettingsBase usará o nome da classe wrapper.
SettingsGroupDescriptionAttribute Classe Fornece o teste descritivo para um grupo de configurações, usado principalmente por ferramentas de tempo de execução e tempo de design.
SettingsManageabilityAttribute Ambos Especifica um ou mais serviços de gerenciamento que devem ser fornecidos ao grupo de configurações ou à propriedade. Os serviços disponíveis são descritos pela SettingsManageability enumeração.
SpecialSettingAttribute Propriedade Indica que uma configuração pertence a uma categoria especial predefinida, como uma cadeia de conexão, que sugere processamento especial pelo provedor de configurações. As categorias predefinidas para esse atributo são definidas pela SpecialSetting enumeração.
SettingsSerializeAsAttribute Ambos Especifica um mecanismo de serialização preferencial para um grupo de configurações ou propriedade. Os mecanismos de serialização disponíveis são definidos pela SettingsSerializeAs enumeração.
NoSettingsVersionUpgradeAttribute Propriedade Especifica que um provedor de configurações deve desabilitar todas as funcionalidades de atualização do aplicativo para a propriedade marcada.

A classe indica que o atributo só pode ser aplicado a uma classe wrapper de configurações de aplicativo. A propriedade indica que o atributo pode ser aplicado apenas às propriedades de configurações. Ambos indicam que o atributo pode ser aplicado em qualquer nível.

Consulte também