Instellingen opslaan en laden in een UWP-app

In dit onderwerp wordt beschreven wat u moet weten om aan de slag te gaan met het laden en opslaan van instellingen in een UWP-app (Universal Windows Platform). De belangrijkste API's worden geïntroduceerd en er zijn koppelingen beschikbaar om u te helpen meer te weten te komen.

Gebruik instellingen om de door de gebruiker aanpasbare aspecten van uw app te onthouden. Een nieuwslezer kan bijvoorbeeld app-instellingen gebruiken om op te slaan welke nieuwsbronnen moeten worden weergegeven en welk lettertype moet worden gebruikt voor het lezen van artikelen.

We bekijken code om app-instellingen op te slaan en te laden.

Wat moet u weten?

Gebruik app-instellingen om configuratiegegevens op te slaan, zoals gebruikersvoorkeuren en app-status.

De volgende gegevenstypen kunnen worden gebruikt met instellingen: gehele getallen, doubles, floats, tekenreeksen, punten, datum/tijd en meer. U kunt ook exemplaren van de ApplicationDataCompositeValue klasse opslaan. Deze klasse is handig wanneer er meerdere instellingen zijn die als een eenheid moeten worden behandeld. Een tekennaam en puntgrootte voor het weergeven van tekst in het leesvenster van uw app moeten bijvoorbeeld als één eenheid worden opgeslagen/hersteld. Dit voorkomt dat een instelling niet meer synchroon loopt met een andere als gevolg van gelijktijdige toegang, zoals tussen het hoofdprogramma en een achtergrondtaak.

Hier volgen de belangrijkste API's die u moet weten over het opslaan of laden van app-instellingen:

• Windows.Storage.ApplicationData.Current.LocalSettings haalt de container met toepassingsinstellingen op uit het lokale app-gegevensarchief. Hier opgeslagen instellingen worden op het apparaat bewaard.
• Windows.Storage.ApplicationData.Current.RoamingSettings haalt de container met toepassingsinstellingen op uit het gegevensarchief van de roaming-app. Instellingen die hier zijn opgeslagen, worden niet meer gesynchroniseerd (vanaf Windows 11), maar de instellingenopslag is nog steeds beschikbaar. De aanbevolen vervanging voor RoamingSettings is Azure App Service-. Azure App Service wordt breed ondersteund, goed gedocumenteerd, betrouwbaar en biedt ondersteuning voor platformoverschrijdende of cross-ecosystemscenario's zoals iOS, Android en web.
• Windows.Storage.ApplicationDataContainer is een container die app-instellingen vertegenwoordigt als sleutel-waardeparen. Gebruik deze klasse om instellingswaarden te maken en op te halen.
• Windows.Storage.ApplicationDataCompositeValue meerdere app-instellingen vertegenwoordigt die als eenheid moeten worden geserialiseerd. Dit is handig wanneer een instelling niet onafhankelijk van een andere instelling moet worden bijgewerkt.

App-instellingen opslaan

Voor deze inleiding richten we ons op twee eenvoudige scenario's: het opslaan en laden van een eenvoudige app-instelling, en het opslaan en laden van een instelling voor samengesteld lettertype/tekengrootte.

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;

Sla een instelling op door eerst een ApplicationDataContainer- op te halen voor het gegevensarchief met lokale instellingen met Windows.Storage.ApplicationData.Current.LocalSettings. Sleutel-/waardewoordenlijstparen die u aan dit exemplaar toewijst, worden opgeslagen in het gegevensarchief van de lokale apparaatinstelling.

In het bovenstaande codefragment slaat een ApplicationDataCompositeValue meerdere sleutel-/waardeparen op. Samengestelde waarden zijn nuttig wanneer je meerdere instellingen hebt die niet uit de pas met elkaar moeten lopen. Wanneer u een ApplicationDataCompositeValueopslaat, worden de waarden opgeslagen en geladen als een eenheid of atomisch. Op deze manier raken gerelateerde instellingen niet uit synchronisatie.

App-instellingen laden

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

Laad een instelling door eerst een ApplicationDataContainer exemplaar op te halen voor het gegevensarchief voor lokale instellingen met Windows.Storage.ApplicationData.Current.LocalSettings. Gebruik deze vervolgens om sleutel-waardeparen op te halen. Als de gegevens niet aanwezig zijn, krijgt u een null-object. In C# betekent dit dat de localValue wordt null als de instelling niet bestaat.

Laad een samengestelde instelling door een vergelijkbaar patroon te volgen. Toegang tot sleutel-waardeparen uit het gegevensarchief met lokale instellingen. Als de gegevens niet aanwezig zijn, krijgt u een null ApplicationDataContainer. Daarom is er een if (composite != null)-controle in de bovenstaande voorbeeldcode.

Nuttige API's en documentatie

Hier volgt een kort overzicht van API's en andere nuttige documentatie om u te helpen bij het opslaan en laden van app-instellingen.

Nuttige API's

API (Application Programming Interface)	Beschrijving
ApplicationData.LocalSettings	Hiermee haalt u de container met toepassingsinstellingen op uit het lokale app-gegevensarchief.
ApplicationData.RoamingSettings	U haalt de container met toepassingsinstellingen op uit de roaming app-gegevensopslag.
ApplicationDataContainer	Een container voor app-instellingen die ondersteuning biedt voor het maken, verwijderen, inventariseren en doorlopen van de containerhiërarchie.
Windows.UI.ApplicationSettings-naamruimte	Biedt klassen die u gaat gebruiken om de app-instellingen te definiëren die worden weergegeven in het deelvenster Instellingen van de Windows-shell.

Nuttige documenten

Onderwerp	Beschrijving
richtlijnen voor app-instellingen	Hierin worden aanbevolen procedures beschreven voor het maken en weergeven van app-instellingen.
Instellingen en andere app-gegevens opslaan en ophalen	Stapsgewijze instructies voor het opslaan en ophalen van instellingen.

Nuttige codevoorbeelden

Codevoorbeeld	Beschrijving
Toepassingsgegevensvoorbeeld	Scenario's 2-4 richten zich op instellingen