Enregistrer et charger des paramètres dans une application UWP

Cette rubrique décrit ce que vous devez savoir pour commencer le chargement et l’enregistrement des paramètres dans une application de plateforme Windows universelle (UWP). Les API principales sont introduites et des liens sont fournis pour vous aider à en savoir plus.

Utilisez les paramètres pour mémoriser les aspects personnalisables par l’utilisateur de votre application. Par exemple, un lecteur d’actualités peut utiliser les paramètres de l’application pour enregistrer les sources d’actualités à afficher et la police à utiliser pour lire des articles.

Nous allons examiner le code pour enregistrer et charger les paramètres de l’application.

Que devez-vous savoir ?

Utilisez les paramètres d’application pour stocker des données de configuration telles que les préférences utilisateur et l’état de l’application.

Les types de données suivants peuvent être utilisés avec des paramètres : entiers, doubles, floats, chars, chaînes, Points, DateTimes, etc. Vous pouvez également stocker des instances de la classe ApplicationDataCompositeValue qui est utile lorsqu’il existe plusieurs paramètres qui doivent être traités comme une unité. Par exemple, un nom de police et une taille de point pour l’affichage du texte dans le volet de lecture de votre application doivent être enregistrés/restaurés en une seule unité. Cela empêche un paramètre de sortir de la synchronisation avec l’autre en raison d’un accès simultané, par exemple entre le programme principal et une tâche en arrière-plan.

Voici les PRINCIPALES API que vous devez savoir sur l’enregistrement ou le chargement des paramètres d’application :

• Windows.Storage.ApplicationData.Current.LocalSettings obtient le conteneur des paramètres de l’application à partir du magasin de données d’application local. Les paramètres stockés ici sont conservés sur l’appareil.
• Windows.Storage.ApplicationData.Current.RoamingSettings obtient le conteneur des paramètres d’application à partir du magasin de données d’application itinérant. Les paramètres stockés ici ne sont plus itinérants (à partir de Windows 11), mais le magasin de paramètres est toujours disponible. Le remplacement recommandé pour RoamingSettings est Azure App Service. Azure App Service est largement pris en charge, bien documenté, fiable et prend en charge des scénarios multiplateformes/inter-écosystèmes tels que iOS, Android et web.
• Windows.Storage.ApplicationDataContainer est un conteneur qui représente les paramètres de l’application sous forme de paires clé/valeur. Utilisez cette classe pour créer et récupérer des valeurs de paramètre.
• Windows.Storage.ApplicationDataCompositeValue représente plusieurs paramètres d’application qui doivent être sérialisés en tant qu’unité. Cela est utile lorsqu’un paramètre ne doit pas être mis à jour indépendamment d’un autre.

Enregistrer les paramètres de l’application

Pour cette introduction, nous allons nous concentrer sur deux scénarios simples : l’enregistrement et le chargement d’un paramètre d’application simple, ainsi que l’enregistrement et le chargement d’un paramètre de police composite/taille de police.

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;

Enregistrez un paramètre en obtenant d’abord un ApplicationDataContainer pour le magasin de données des paramètres locaux avec Windows.Storage.ApplicationData.Current.LocalSettings. Les paires de dictionnaires clé/valeur que vous affectez à cette instance sont enregistrées dans le magasin de données du paramètre d’appareil local.

Dans l’extrait de code ci-dessus, une applicationDataCompositeValue stocke plusieurs paires clé/valeur. Les valeurs composites sont utiles lorsque vous avez plusieurs paramètres qui ne doivent pas être synchronisés les uns avec les autres. Lorsque vous enregistrez une Valeur ApplicationDataCompositeValue, les valeurs sont enregistrées et chargées en tant qu’unité, ou atomiquement. De cette façon, les paramètres associés resteront synchronisés.

Charger les paramètres de l’application

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"];
}

Chargez un paramètre en obtenant d'abord une instance ApplicationDataContainer pour l'espace de stockage des paramètres locaux avec Windows.Storage.ApplicationData.Current.LocalSettings. Utilisez-la ensuite pour récupérer des paires clé/valeur. Si les données ne sont pas présentes, vous obtiendrez un objet Null. En C#, cela signifie que le localValue sera null si le paramètre n’existe pas.

Chargez un paramètre composite en suivant un modèle similaire. Accéder aux paires clé/valeur à partir du magasin de données des paramètres locaux. Si les données ne sont pas présentes, vous obtenez une valeur null pour ApplicationDataContainer. C’est pourquoi il existe une vérification if (composite != null) dans l’exemple de code ci-dessus.

API et documents utiles

Voici un résumé rapide des API et d’autres documentations utiles pour vous aider à commencer à enregistrer et charger les paramètres de l’application.

API utiles

Documents utiles

Exemples de code utiles