Udostępnij za pośrednictwem

Atrybuty ustawień aplikacji

  • Artykuł

Architektura ustawień aplikacji zawiera wiele atrybutów, które można zastosować do klasy otoki ustawień aplikacji lub jej poszczególnych właściwości. Te atrybuty są analizowane w czasie wykonywania przez infrastrukturę ustawień aplikacji, często w szczególności dostawcę ustawień, aby dostosować jego funkcjonowanie do określonych potrzeb niestandardowej otoki.

W poniższej tabeli wymieniono atrybuty, które można zastosować do klasy otoki ustawień aplikacji, poszczególnych właściwości tej klasy lub obu tych właściwości. Z definicji tylko jeden atrybut zakresu —UserScopedSettingAttribute lub ApplicationScopedSettingAttribute— należy zastosować do każdej właściwości ustawień.

Notatka

Dostawca ustawień niestandardowych, pochodzący z klasy SettingsProvider, jest wymagany tylko do rozpoznawania następujących trzech atrybutów: ApplicationScopedSettingAttribute, UserScopedSettingAttributei DefaultSettingValueAttribute.

Atrybut Cel Opis
SettingsProviderAttribute Oboje Określa krótką nazwę dostawcy ustawień do użycia na potrzeby trwałości.

Jeśli ten atrybut nie zostanie podany, przyjmuje się, że domyślnym dostawcą jest LocalFileSettingsProvider.
UserScopedSettingAttribute Oba Definiuje właściwość jako ustawienie aplikacji o zakresie użytkownika.
ApplicationScopedSettingAttribute Oba Definiuje właściwość jako ustawienie aplikacji o zakresie aplikacji.
DefaultSettingValueAttribute Własność Określa ciąg, który może być deserializowany przez dostawcę do trwale zakodowanej wartości domyślnej dla tej właściwości.

LocalFileSettingsProvider nie wymaga tego atrybutu i zastąpi dowolną wartość, którą podano przez ten atrybut, jeśli już istnieje zachowana wartość.
SettingsDescriptionAttribute Własność Udostępnia opisowy test dla poszczególnych ustawień, używany głównie przez narzędzia w czasie wykonywania i czasie projektowania.
SettingsGroupNameAttribute Klasa Zawiera jawną nazwę grupy ustawień. Jeśli brakuje tego atrybutu, ApplicationSettingsBase używa nazwy klasy opakowującej.
SettingsGroupDescriptionAttribute Klasa Udostępnia opis testowy dla grupy ustawień, używany głównie przez narzędzia w czasie wykonywania i projektowania.
SettingsManageabilityAttribute Oba Określa zero lub więcej usług do zarządzania, które mają być udostępniane grupie lub właściwości ustawień. Dostępne usługi są opisane przez wyliczenie SettingsManageability.
SpecialSettingAttribute Własność Wskazuje, że ustawienie należy do specjalnej, wstępnie zdefiniowanej kategorii, takiej jak parametry połączenia, które sugeruje specjalne przetwarzanie przez dostawcę ustawień. Wstępnie zdefiniowane kategorie tego atrybutu są definiowane przez wyliczenie SpecialSetting.
SettingsSerializeAsAttribute Oba Określa preferowany mechanizm serializacji dla grupy ustawień lub właściwości. Dostępne mechanizmy serializacji są definiowane przez wyliczenie SettingsSerializeAs.
NoSettingsVersionUpgradeAttribute Własność Określa, że dostawca ustawień powinien wyłączyć wszystkie funkcje uaktualniania aplikacji dla oznaczonej właściwości.

Klasa wskazuje, że atrybut można zastosować tylko do klasy będącej powłoką ustawień aplikacji. właściwość wskazuje, że atrybut można zastosować tylko do właściwości ustawień. Oba wskazują, że atrybut można zastosować na każdym poziomie.

Zobacz też