Atributos de configuración de la aplicación

  • Artículo

La arquitectura de configuración de la aplicación proporciona muchos atributos que se pueden aplicar a la clase contenedora de configuración de aplicaciones o a sus propiedades individuales. La infraestructura de configuración de la aplicación examina estos atributos en tiempo de ejecución, a menudo el proveedor de configuración, para adaptar su funcionamiento a las necesidades indicadas del contenedor personalizado.

En la tabla siguiente se enumeran los atributos que se pueden aplicar a la clase contenedora de configuración de la aplicación, las propiedades individuales de esta clase o ambas. Por definición, solo se debe aplicar un atributo de ámbito único (UserScopedSettingAttribute o ApplicationScopedSettingAttribute) a cada una de las propiedades de configuración.

Nota:

Un proveedor de configuración personalizado, derivado de la clase SettingsProvider, solo es necesario para reconocer los tres atributos siguientes: ApplicationScopedSettingAttribute, UserScopedSettingAttribute y DefaultSettingValueAttribute.

Atributo Destino Descripción
SettingsProviderAttribute Ambos Especifica el nombre corto del proveedor de configuración que se va a usar para la persistencia.

Si no se proporciona este atributo, se asume el proveedor predeterminado, LocalFileSettingsProvider.
UserScopedSettingAttribute Ambos Define una propiedad como una configuración de aplicación con ámbito de usuario.
ApplicationScopedSettingAttribute Ambos Define una propiedad como una configuración de aplicación con ámbito de aplicación.
DefaultSettingValueAttribute Propiedad Especifica una cadena que el proveedor puede deserializar en el valor predeterminado codificado de forma rígida para esta propiedad.

LocalFileSettingsProvider no requiere este atributo e invalidará cualquier valor proporcionado por este atributo si ya hay un valor persistente.
SettingsDescriptionAttribute Propiedad Proporciona la prueba descriptiva para una configuración individual, utilizada principalmente por herramientas en tiempo de ejecución y en tiempo de diseño.
SettingsGroupNameAttribute Clase Proporciona un nombre explícito para un grupo de valores. Si falta este atributo, ApplicationSettingsBase usa el nombre de la clase contenedora.
SettingsGroupDescriptionAttribute Clase Proporciona la prueba descriptiva para un grupo de valores, utilizada principalmente por herramientas en tiempo de ejecución y en tiempo de diseño.
SettingsManageabilityAttribute Ambos Especifica cero o más servicios de manejabilidad que se deben proporcionar al grupo o propiedad de configuración. La enumeración SettingsManageability describe los servicios disponibles.
SpecialSettingAttribute Propiedad Indica que una configuración pertenece a una categoría especial predefinida, como una cadena de conexión, que sugiere un procesamiento especial por parte del proveedor de configuración. La enumeración SpecialSetting define las categorías predefinidas para este atributo.
SettingsSerializeAsAttribute Ambos Especifica un mecanismo de serialización preferido para un grupo o propiedad de configuración. La enumeración SettingsSerializeAs define los mecanismos de serialización disponibles.
NoSettingsVersionUpgradeAttribute Propiedad Especifica que un proveedor de configuración debe deshabilitar toda la funcionalidad de actualización de aplicaciones para la propiedad marcada.

Clase indica que el atributo solo se puede aplicar a una clase contenedora de configuración de la aplicación. Propiedad indica que el atributo solo se puede aplicar a las propiedades de configuración. Ambos indica que el atributo se puede aplicar a cualquier nivel.

Consulte también