Guardar y cargar la configuración en una aplicación para UWP

En este tema se explica lo que necesitas saber para empezar a cargar y guardar la configuración en una aplicación para la Plataforma universal de Windows (UWP). Se presentan las API principales y se proporcionan vínculos para ayudarle a obtener más información.

Usa la configuración para recordar los aspectos personalizables por el usuario de la aplicación. Por ejemplo, un lector de noticias podría usar la configuración de la aplicación para guardar qué fuentes de noticias mostrar y qué fuente usar para leer artículos.

Veremos el código para guardar y cargar la configuración de la aplicación.

¿Qué necesita saber?

Use la configuración de la aplicación para almacenar datos de configuración, como preferencias de usuario y estado de la aplicación.

Los siguientes tipos de datos se pueden usar con las configuraciones: enteros, dobles, flotantes, caracteres, cadenas, puntos, fechas y horas, etc. También puede almacenar instancias de la clase ApplicationDataCompositeValue que resulta útil cuando hay varias opciones de configuración que se deben tratar como una unidad. Por ejemplo, un nombre de fuente y un tamaño de punto para mostrar texto en el panel de lectura de la aplicación debe guardarse o restaurarse como una sola unidad. Esto impide que una configuración se desincronice con la otra debido al acceso simultáneo, como entre el programa principal y una tarea en segundo plano.

Estas son las API principales que debe conocer para guardar o cargar la configuración de la aplicación:

• Windows.Storage.ApplicationData.Current.LocalSettings obtiene el contenedor de configuración de la aplicación del almacén de datos locales de la aplicación. La configuración almacenada aquí se mantiene en el dispositivo.
• windows.Storage.ApplicationData.Current.RoamingSettings obtiene el contenedor de configuración de la aplicación del almacén de datos de la aplicación móvil. La configuración almacenada aquí ya no se sincroniza (a partir de Windows 11), pero el almacenamiento de configuración sigue estando disponible. El reemplazo recomendado para RoamingSettings es Azure App Service. Azure App Service es ampliamente compatible, bien documentado, confiable y admite escenarios multiplataforma o entre ecosistemas, como iOS, Android y web.
• Windows.Storage.ApplicationDataContainer es un contenedor que representa la configuración de la aplicación como pares clave-valor. Use esta clase para crear y recuperar valores de configuración.
• Windows.Storage.ApplicationDataCompositeValue representa varias opciones de configuración de la aplicación que se deben serializar como una unidad. Esto resulta útil cuando una configuración no se debe actualizar independientemente de otra.

Guardar la configuración de la aplicación

Para esta introducción, nos centraremos en dos escenarios sencillos: guardar y cargar una configuración de aplicación sencilla, y guardar y cargar una configuración de tamaño de fuente o fuente compuesta.

ApplicationDataContainer localSettings = Windows.Storage.ApplicationData.Current.LocalSettings;

// Save a setting locally on the device
localSettings.Values["test setting"] = "a device specific setting";

// Save a composite setting locally on the device
Windows.Storage.ApplicationDataCompositeValue composite = new Windows.Storage.ApplicationDataCompositeValue();
composite["Font"] = "Calibri";
composite["FontSize"] = 11;
localSettings.Values["FontInfo"] = composite;

Guarde una configuración obteniendo primero un applicationDataContainer para el almacén de datos de configuración local con Windows.Storage.ApplicationData.Current.LocalSettings. Los pares de diccionario clave-valor que se asignan a esta instancia se guardan en el almacén de datos de configuración del dispositivo local.

En el fragmento de código anterior, applicationDataCompositeValue almacena varios pares clave-valor. Los valores compuestos son útiles cuando tiene varias configuraciones que no deben salir de la sincronización entre sí. Al guardar un applicationDataCompositeValue, los valores se guardan y cargan como una unidad o de forma atómica. De este modo, la configuración relacionada no dejará de sincronizarse.

Carga de la configuración de la aplicación

ApplicationDataContainer localSettings = Windows.Storage.ApplicationData.Current.LocalSettings;

// load a setting that is local to the device
String localValue = localSettings.Values["test setting"] as string;

// load a composite setting
Windows.Storage.ApplicationDataCompositeValue composite = (ApplicationDataCompositeValue)localSettings.Values["FontInfo"];
if (composite != null)
{
    String fontName = composite["Font"] as string;
    int fontSize = (int)composite["FontSize"];
}

Para cargar una configuración, primero obtenga una instancia ApplicationDataContainer para el almacén de datos de configuración local con Windows.Storage.ApplicationData.Current.LocalSettings. Después, úselo para recuperar pares clave-valor. Si los datos no están presentes, obtendrá un objeto NULL. En C#, esto significa que el localValue se convertirá en null si la configuración no existe.

Cargue una configuración compuesta siguiendo un patrón similar. Acceda a pares clave-valor desde el almacén de datos de configuración local. Si los datos no están presentes, obtendrá un applicationDataContainer nulo. Por eso hay una verificación de if (composite != null) en el código de ejemplo anterior.

API y documentos útiles

Este es un resumen rápido de las API y otra documentación útil para ayudarle a empezar a guardar y cargar la configuración de la aplicación.

API útiles

Interfaz de Programación de Aplicaciones (API)	Descripción
ApplicationData.LocalSettings	Obtiene el contenedor de configuración de la aplicación del almacén de datos de la aplicación local.
Configuración de Datos de Aplicación en Itinerancia	Obtiene el contenedor de configuración de la aplicación del almacén de datos de aplicación itinerante.
ContenedorDeDatosDeAplicación	Contenedor para la configuración de la aplicación que admite la creación, eliminación, enumeración y recorrido de la jerarquía de contenedores.
espacio de nombres Windows.UI.ApplicationSettings	Proporciona clases que usarás para definir la configuración de la aplicación que aparecen en el panel de configuración del shell de Windows.

Documentos útiles

Tema	Descripción
Directrices para la configuración de la aplicación	Describe los procedimientos recomendados para crear y mostrar la configuración de la aplicación.
Almacenar y recuperar la configuración y otros datos de la aplicación	Tutorial para guardar y recuperar la configuración.

Ejemplos de código útiles

Ejemplo de código	Descripción
Muestra de datos de aplicación	Los escenarios 2-4 se centran en la configuración