Share via

Atributos de Configurações de Aplicativo

  • Artigo

A arquitetura de Configurações de Aplicativo fornece muitos atributos que podem ser aplicados à classe wrapper de configurações de aplicativos ou suas propriedades individuais. Esses atributos são examinados no tempo de execução pela infraestrutura de configurações de aplicativo, geralmente especificamente pelo 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 de aplicativo, às propriedades individuais desta classe ou a ambos. Por definição, somente um único atributo de escopo —UserScopedSettingAttribute ou ApplicationScopedSettingAttribute— deve ser aplicado a todas as propriedades de configurações.

Observação

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

Atributo Target (destino) Descrição
SettingsProviderAttribute Ambos Especifica o nome curto do provedor 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 no escopo do usuário.
ApplicationScopedSettingAttribute Ambos Define uma propriedade como uma configuração de aplicativo no escopo do aplicativo.
DefaultSettingValueAttribute Propriedade Especifica uma cadeia de caracteres que pode ser desserializada pelo provedor para o valor padrão embutido em código para essa propriedade.

O LocalFileSettingsProvider não requer esse atributo e substituirá qualquer valor fornecido por esse atributo se houver um valor já persistido.
SettingsDescriptionAttribute Propriedade Fornece o teste descritivo para uma configuração individual, usada primariamente por ferramentas de tempo de execução e de tempo 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 primariamente por ferramentas de tempo de execução e de tempo de design.
SettingsManageabilityAttribute Ambos Especifica zero ou mais serviços de gerenciabilidade que devem ser fornecidos para o 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 e predefinida, como uma cadeia de conexão, o que sugere um 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 preferencial de serialização 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 funcionalidade de atualização de aplicativo para a propriedade marcada.

Classe indica que o atributo pode ser aplicado somente a uma classe wrapper de configurações de aplicativo. Propriedade indica que o atributo pode ser aplicado somente a propriedades de configurações. Ambos indica que o atributo pode ser aplicado em qualquer nível.

Confira também