Uložení a načtení nastavení v aplikaci pro UPW

Toto téma popisuje, co potřebujete vědět, abyste mohli začít načítat a ukládat nastavení v aplikaci Univerzální platforma Windows (UPW). Zavádějí se hlavní rozhraní API a poskytují se odkazy, které vám pomůžou získat další informace.

Pomocí nastavení si zapamatujte uživatelsky přizpůsobitelné aspekty vaší aplikace. Čtenář zpráv může například použít nastavení aplikace k uložení zdrojů zpráv, které se mají zobrazit a jaké písmo použít pro články pro čtení.

Podíváme se na kód pro uložení a načtení nastavení aplikace.

Co potřebujete vědět

Nastavení aplikace slouží k ukládání konfiguračních dat, jako jsou uživatelské předvolby a stav aplikace.

Následující datové typy lze použít s nastavením: celá čísla, desetinné hodnoty, desetinná čísla, znaky, řetězce, body, datum a čas a další. Můžete také uložit instance třídy ApplicationDataCompositeValue třídy, která je užitečná v případě, že existuje více nastavení, která by se měla považovat za jednotku. Například název písma a velikost bodu pro zobrazení textu v podokně čtení aplikace by se měly uložit nebo obnovit jako jedna jednotka. Díky souběžnému přístupu, například mezi hlavním programem a úlohou na pozadí, zabráníte tomu, aby se jedno nastavení nesynchronizuje s druhým nastavením.

Tady jsou hlavní rozhraní API, která potřebujete vědět o ukládání nebo načítání nastavení aplikace:

• Windows. Storage.ApplicationData.Current.LocalSettings získá kontejner nastavení aplikace z místního úložiště dat aplikace. Nastavení uložená zde se uchovávají na zařízení a spolehlivě se uchovávají prostřednictvím aktualizací aplikací.
• Windows. Storage.ApplicationData.Current.RoamingSettings získá kontejner nastavení aplikace z úložiště dat roamingové aplikace. Nastavení uložená zde již neputují (od Windows 11), ale úložiště nastavení je stále dostupné. Doporučená náhrada pro RoamingSettings je Azure App Service. Azure App Service je široce podporovaná, dobře zdokumentovaná, spolehlivá a podporuje scénáře pro různé platformy nebo různé ekosystémy, jako jsou iOS, Android a web.
• Windows. Storage.ApplicationDataContainer je kontejner, který představuje nastavení aplikace jako páry klíč/hodnota. Pomocí této třídy můžete vytvořit a získat hodnoty nastavení.
• Windows. Storage.ApplicationDataCompositeValue představuje více nastavení aplikace, která by se měla serializovat jako jednotka. To je užitečné, když by se jedno nastavení nemělo aktualizovat nezávisle na druhém.

Důležité

RoamingSettings nemusí přetrvávat při aktualizacích aplikace Microsoft Store. Pro nastavení, která musí přežít aktualizace aplikace, použijte místo toho LocalSettings.

Uložení nastavení aplikace

V tomto úvodu se zaměříme na dva jednoduché scénáře: ukládání a načítání jednoduchého nastavení aplikace a ukládání a načítání složeného nastavení písma a velikosti písma.

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;

Nejprve načtěte ApplicationDataContainer pro místní úložiště dat nastavení pomocí Windows.Storage.ApplicationData.Current.LocalSettings a poté uložte nastavení. Páry slovníku klíč/hodnota, které přiřadíte k této instanci, se ukládají do úložiště dat nastavení místního zařízení.

Ve výše uvedeném fragmentu kódu ukládá ApplicationDataCompositeValue několik dvojic klíč/hodnota. Složené hodnoty jsou užitečné, když máte více nastavení, která by se neměla vzájemně vychýlit ze synchronizace. Když uložíte ApplicationDataCompositeValue, hodnoty se uloží a načtou jednotně nebo atomicky. Tímto způsobem se související nastavení nevychýlí ze synchronizace.

Načtení nastavení aplikace

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

Nejprve načtěte nastavení tak, že nejprve čtete instanci ApplicationDataContainer pro místní úložiště dat nastavení s Windows.Storage.ApplicationData.Current.LocalSettings. Pak ho použijte k načtení párů klíč/hodnota. Pokud data nejsou k dispozici, získáte objekt null. V jazyce C# to znamená, že localValue bude null, pokud nastavení neexistuje.

Načtěte složené nastavení dle podobného vzoru. Páry přístupových klíčů a hodnot z místního úložiště dat nastavení. Pokud data nejsou k dispozici, získáte hodnotu Null ApplicationDataContainer. To je důvod, proč je v ukázkovém kódu výše kontrola if (composite != null).

Užitečná rozhraní API a dokumentace

Tady je rychlý souhrn rozhraní API a další užitečné dokumentace, které vám pomůžou začít s ukládáním a načítáním nastavení aplikace.

Užitečná rozhraní API

API	Popis
ApplicationData.LocalSettings	Získá kontejner nastavení aplikace z místního úložiště dat aplikace.
ApplicationData.RoamingSettings	Získá kontejner nastavení aplikace z úložiště dat roamingové aplikace.
ApplicationDataContainer	Kontejner pro nastavení aplikace, který podporuje vytváření, odstraňování, výčet a procházení hierarchie kontejnerů.
Windows.UI.ApplicationSettings Namespace	Poskytuje třídy, které použijete k definování nastavení aplikace, která se zobrazí v podokně nastavení Windows prostředí.

Užitečné dokumenty

Téma	Popis
Pokyny pro nastavení aplikací	Popisuje osvědčené postupy pro vytváření a zobrazování nastavení aplikace.
Uložení a načtení nastavení a dalších dat aplikace	Návod k ukládání a načítání nastavení

Užitečné ukázky kódu

Ukázka kódu	Popis
Ukázka aplikačních dat	Scénáře 2–4 se zaměřují na nastavení