Attributs des paramètres d'application

  • Article

L’architecture application Paramètres fournit de nombreux attributs qui peuvent être appliqués à la classe wrapper des paramètres des applications ou à ses propriétés individuelles. Ces attributs sont examinés au moment de l’exécution par l’infrastructure des paramètres d’application, souvent spécifiquement le fournisseur de paramètres, afin d’adapter son fonctionnement aux besoins indiqués du wrapper personnalisé.

Le tableau suivant répertorie les attributs qui peuvent être appliqués à la classe wrapper des paramètres d’application, les propriétés individuelles de cette classe ou les deux. Par définition, seul un attribut d’étendue unique (UserScopedSettingAttribute ou ApplicationScopedSettingAttribute) doit être appliqué à chaque propriété de paramètres.

Remarque

Un fournisseur de paramètres personnalisés, dérivé de la SettingsProvider classe, est uniquement nécessaire pour reconnaître les trois attributs suivants : ApplicationScopedSettingAttribute, UserScopedSettingAttribute et DefaultSettingValueAttribute.

Attribut Cible Description
SettingsProviderAttribute Les deux Spécifie le nom court du fournisseur de paramètres à utiliser pour la persistance.

Si cet attribut n’est pas fourni, le fournisseur par défaut, LocalFileSettingsProviderest supposé.
UserScopedSettingAttribute Les deux Définit une propriété comme paramètre d’application délimitée par l’utilisateur.
ApplicationScopedSettingAttribute Les deux Définit une propriété en tant que paramètre d’application délimitée par l’application.
DefaultSettingValueAttribute Propriété Spécifie une chaîne qui peut être désérialisée par le fournisseur dans la valeur par défaut codée en dur pour cette propriété.

Cette LocalFileSettingsProvider propriété ne nécessite pas cet attribut et remplace toute valeur fournie par cet attribut s’il existe déjà une valeur persistante.
SettingsDescriptionAttribute Propriété Fournit le test descriptif d’un paramètre individuel, principalement utilisé par les outils au moment de l’exécution et au moment du design.
SettingsGroupNameAttribute Classe Fournit un nom explicite pour un groupe de paramètres. Si cet attribut est manquant, ApplicationSettingsBase utilise le nom de la classe wrapper.
SettingsGroupDescriptionAttribute Classe Fournit le test descriptif d’un groupe de paramètres, principalement utilisé par les outils au moment de l’exécution et au moment du design.
SettingsManageabilityAttribute Les deux Spécifie zéro ou plus de services de facilité de gestion qui doivent être fournis au groupe de paramètres ou à la propriété. Les services disponibles sont décrits par l’énumération SettingsManageability .
SpecialSettingAttribute Propriété Indique qu’un paramètre appartient à une catégorie spéciale prédéfinie, telle qu’un chaîne de connexion, qui suggère un traitement spécial par le fournisseur de paramètres. Les catégories prédéfinies pour cet attribut sont définies par l’énumération SpecialSetting .
SettingsSerializeAsAttribute Les deux Spécifie un mécanisme de sérialisation préféré pour un groupe de paramètres ou une propriété. Les mécanismes de sérialisation disponibles sont définis par l’énumération SettingsSerializeAs .
NoSettingsVersionUpgradeAttribute Propriété Spécifie qu’un fournisseur de paramètres doit désactiver toutes les fonctionnalités de mise à niveau d’application pour la propriété marquée.

La classe indique que l’attribut ne peut être appliqué qu’à une classe wrapper de paramètres d’application. La propriété indique que l’attribut peut être appliqué uniquement aux propriétés des paramètres. Les deux indiquent que l’attribut peut être appliqué à l’un ou l’autre niveau.

Voir aussi