refactor: migrate to Microsoft.Windows.Storage.ApplicationData and centralize settings keys (#1900)

Zakariathr22 · niels9001 · web-flow · commit 1d59dfefc539 · 2025-07-03T08:50:43.000-07:00
## Description - Replace `Windows.Storage.ApplicationData` with `Microsoft.Windows.Storage.ApplicationData`. - Centralize Settings Keys in a `SettingsKeys` Class. - define key constants in `ScratchPadPage`. ## Motivation and Context - Closes #1892 - Closes #1893 ## How Has This Been Tested? **Manually tested** ## Screenshots (if appropriate): ## Types of changes  - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) Co-authored-by: Niels Laute <niels.laute@live.nl>
diff --git a/WinUIGallery/Helpers/NavigationOrientationHelper.cs b/WinUIGallery/Helpers/NavigationOrientationHelper.cs
@@ -3,25 +3,23 @@
 
 using Microsoft.UI.Xaml;
 using Microsoft.UI.Xaml.Controls;
-using Windows.Storage;
+using Microsoft.Windows.Storage;
 using WinUIGallery.Pages;
 
 namespace WinUIGallery.Helpers;
 
 public static class NavigationOrientationHelper
 {
-
-    private const string IsLeftModeKey = "NavigationIsOnLeftMode";
     private static bool _isLeftMode = true;
-
+    private static ApplicationData appData = ApplicationData.GetDefault();
     public static bool IsLeftMode()
     {
         if (NativeHelper.IsAppPackaged)
         {
-            var valueFromSettings = ApplicationData.Current.LocalSettings.Values[IsLeftModeKey];
+            var valueFromSettings = appData.LocalSettings.Values[SettingsKeys.IsLeftMode];
             if (valueFromSettings == null)
             {
-                ApplicationData.Current.LocalSettings.Values[IsLeftModeKey] = true;
+                appData.LocalSettings.Values[SettingsKeys.IsLeftMode] = true;
                 valueFromSettings = true;
             }
             return (bool)valueFromSettings;
@@ -37,7 +35,7 @@ public static void IsLeftModeForElement(bool isLeftMode, UIElement element)
         UpdateNavigationViewForElement(isLeftMode, element);
         if (NativeHelper.IsAppPackaged)
         {
-            ApplicationData.Current.LocalSettings.Values[IsLeftModeKey] = isLeftMode;
+            appData.LocalSettings.Values[SettingsKeys.IsLeftMode] = isLeftMode;
         }
         else
         {
diff --git a/WinUIGallery/Helpers/ProtocolActivationClipboardHelper.cs b/WinUIGallery/Helpers/ProtocolActivationClipboardHelper.cs
@@ -4,7 +4,7 @@
 using System;
 using Windows.ApplicationModel;
 using Windows.ApplicationModel.DataTransfer;
-using Windows.Storage;
+using Microsoft.Windows.Storage;
 using WinUIGallery.Models;
 
 namespace WinUIGallery.Helpers;
@@ -14,19 +14,19 @@ namespace WinUIGallery.Helpers;
 /// </summary>
 public static class ProtocolActivationClipboardHelper
 {
-    private const string ShowCopyLinkTeachingTipKey = "ShowCopyLinkTeachingTip";
     private static bool _showCopyLinkTeachingTip = true;
+    private static ApplicationData appData = ApplicationData.GetDefault();
 
     public static bool ShowCopyLinkTeachingTip
     {
         get
         {
             if (NativeHelper.IsAppPackaged)
             {
-                object valueFromSettings = ApplicationData.Current.LocalSettings.Values[ShowCopyLinkTeachingTipKey];
+                object valueFromSettings = appData.LocalSettings.Values[SettingsKeys.ShowCopyLinkTeachingTip];
                 if (valueFromSettings == null)
                 {
-                    ApplicationData.Current.LocalSettings.Values[ShowCopyLinkTeachingTipKey] = true;
+                    appData.LocalSettings.Values[SettingsKeys.ShowCopyLinkTeachingTip] = true;
                     valueFromSettings = true;
                 }
                 return (bool)valueFromSettings;
@@ -41,7 +41,7 @@ public static bool ShowCopyLinkTeachingTip
         {
             if (NativeHelper.IsAppPackaged)
             {
-                ApplicationData.Current.LocalSettings.Values[ShowCopyLinkTeachingTipKey] = value;
+                appData.LocalSettings.Values[SettingsKeys.ShowCopyLinkTeachingTip] = value;
 
             }
             else
diff --git a/WinUIGallery/Helpers/SettingsHelper.cs b/WinUIGallery/Helpers/SettingsHelper.cs
@@ -190,19 +190,3 @@ private static bool TrySaveList(string key, List<string> items)
         return true;
     }
 }
-
-/// <summary>
-/// Provides constant keys used for accessing application settings.
-/// </summary>
-public static class SettingsKeys
-{
-    /// <summary>
-    /// Key for the list of favorited Pages.
-    /// </summary>
-    public const string Favorites = "Favorites";
-
-    /// <summary>
-    /// Key for the list of recently visited Pages.
-    /// </summary>
-    public const string RecentlyVisited = "RecentlyVisited";
-}
diff --git a/WinUIGallery/Helpers/SettingsKeys.cs b/WinUIGallery/Helpers/SettingsKeys.cs
@@ -0,0 +1,34 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+namespace WinUIGallery.Helpers;
+
+/// <summary>
+/// Provides constant keys used for accessing application settings.
+/// </summary>
+public static class SettingsKeys
+{
+    /// <summary>
+    /// The key used to store or retrieve the selected application theme.
+    /// </summary>
+    public const string SelectedAppTheme = "SelectedAppTheme";
+
+    /// <summary>
+    /// Represents the key used to determine whether the navigation is in "left mode."
+    /// </summary>
+    public const string IsLeftMode = "NavigationIsOnLeftMode";
+
+    /// <summary>
+    /// Key for the list of recently visited Pages.
+    /// </summary>
+    public const string RecentlyVisited = "RecentlyVisited";
+
+    /// <summary>
+    /// Key for the list of favorited Pages.
+    /// </summary>
+    public const string Favorites = "Favorites";
+
+    /// <summary>
+    /// Represents the key used to identify the "Show Copy Link" teaching tip of the protocol activation clipboard.
+    /// </summary>
+    public const string ShowCopyLinkTeachingTip = "ShowCopyLinkTeachingTip";
+}
diff --git a/WinUIGallery/Helpers/ThemeHelper.cs b/WinUIGallery/Helpers/ThemeHelper.cs
@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 using Microsoft.UI.Xaml;
-using Windows.Storage;
+using Microsoft.Windows.Storage;
 
 namespace WinUIGallery.Helpers;
 
@@ -11,7 +11,7 @@ namespace WinUIGallery.Helpers;
 /// </summary>
 public static class ThemeHelper
 {
-    private const string SelectedAppThemeKey = "SelectedAppTheme";
+    private static ApplicationData appData = ApplicationData.GetDefault();
 
     /// <summary>
     /// Gets the current actual theme of the app based on the requested theme of the
@@ -65,7 +65,7 @@ public static ElementTheme RootTheme
 
             if (NativeHelper.IsAppPackaged)
             {
-                ApplicationData.Current.LocalSettings.Values[SelectedAppThemeKey] = value.ToString();
+                appData.LocalSettings.Values[SettingsKeys.SelectedAppTheme] = value.ToString();
             }
         }
     }
@@ -74,7 +74,7 @@ public static void Initialize()
     {
         if (NativeHelper.IsAppPackaged)
         {
-            string savedTheme = ApplicationData.Current.LocalSettings.Values[SelectedAppThemeKey]?.ToString();
+            string savedTheme = appData.LocalSettings.Values[SettingsKeys.SelectedAppTheme]?.ToString();
 
             if (savedTheme != null)
             {
diff --git a/WinUIGallery/Samples/ControlPages/Fundamentals/ScratchPadPage.xaml.cs b/WinUIGallery/Samples/ControlPages/Fundamentals/ScratchPadPage.xaml.cs
@@ -16,6 +16,15 @@ namespace WinUIGallery.ControlPages;
 
 public sealed partial class ScratchPadPage : Page
 {
+    // The name of the ApplicationData container used to store all ScratchPad-related settings.
+    private const string containerKey = "ScratchPad";
+
+    // The key under the ScratchPad container for storing the XAML composite value.
+    private const string xamlCompositeValueKey = "ScratchPadXAML";
+
+    // The key within the XAML composite value that stores the number of 4KB segments.
+    private const string xamlSegmentCountKey = "count";
+
     public ScratchPadPage()
     {
         this.InitializeComponent();
@@ -62,16 +71,16 @@ private string GetDefaultScratchXAML()
 
     public string ReadScratchPadXAMLinLocalSettings()
     {
-        var appData = ApplicationData.Current;
-        if (appData.LocalSettings.Containers.ContainsKey("ScratchPad"))
+        var appData = Microsoft.Windows.Storage.ApplicationData.GetDefault();
+        if (appData.LocalSettings.Containers.ContainsKey(containerKey))
         {
-            var scratchPadContainer = appData.LocalSettings.CreateContainer("ScratchPad", ApplicationDataCreateDisposition.Existing);
-            if (scratchPadContainer != null && scratchPadContainer.Values.ContainsKey("ScratchPadXAML"))
+            var scratchPadContainer = appData.LocalSettings.CreateContainer(containerKey, Microsoft.Windows.Storage.ApplicationDataCreateDisposition.Existing);
+            if (scratchPadContainer != null && scratchPadContainer.Values.ContainsKey(xamlCompositeValueKey))
             {
                 // String values are limited to 4K characters. Use a composite value to support a longer string.
-                var compositeStr = scratchPadContainer.Values["ScratchPadXAML"] as ApplicationDataCompositeValue;
+                var compositeStr = scratchPadContainer.Values[xamlCompositeValueKey] as ApplicationDataCompositeValue;
                 var xamlStr = "";
-                int count = (int)compositeStr["count"];
+                int count = (int)compositeStr[xamlSegmentCountKey];
                 for (int i = 0; i < count; i++)
                 {
                     xamlStr += compositeStr[i.ToString()];
@@ -84,8 +93,8 @@ public string ReadScratchPadXAMLinLocalSettings()
 
     public void SaveScratchPadXAMLinLocalSettings(string xamlStr)
     {
-        var appData = ApplicationData.Current;
-        var scratchPadContainer = appData.LocalSettings.CreateContainer("ScratchPad", ApplicationDataCreateDisposition.Always);
+        var appData = Microsoft.Windows.Storage.ApplicationData.GetDefault();
+        var scratchPadContainer = appData.LocalSettings.CreateContainer(containerKey, Microsoft.Windows.Storage.ApplicationDataCreateDisposition.Existing);
         // String values are limited to 4K characters. Use a composite value to support a longer string.
         var compositeStr = new ApplicationDataCompositeValue();
         int count = 0;
@@ -96,8 +105,8 @@ public void SaveScratchPadXAMLinLocalSettings(string xamlStr)
             count++;
             xamlStr = xamlStr.Substring(len);
         }
-        compositeStr["count"] = count;
-        scratchPadContainer.Values["ScratchPadXAML"] = compositeStr;
+        compositeStr[xamlSegmentCountKey] = count;
+        scratchPadContainer.Values[xamlCompositeValueKey] = compositeStr;
     }
 
     private async void ResetToDefaultClick(object sender, RoutedEventArgs e)

Original file line number	Diff line number	Diff line change
`@@ -3,25 +3,23 @@`
`3`	`3`
`4`	`4`	`using Microsoft.UI.Xaml;`
`5`	`5`	`using Microsoft.UI.Xaml.Controls;`
`6`		`-using Windows.Storage;`
	`6`	`+using Microsoft.Windows.Storage;`
`7`	`7`	`using WinUIGallery.Pages;`
`8`	`8`
`9`	`9`	`namespace WinUIGallery.Helpers;`
`10`	`10`
`11`	`11`	`public static class NavigationOrientationHelper`
`12`	`12`	`{`
`13`		`-`
`14`		`- private const string IsLeftModeKey = "NavigationIsOnLeftMode";`
`15`	`13`	`private static bool _isLeftMode = true;`
`16`		`-`
	`14`	`+ private static ApplicationData appData = ApplicationData.GetDefault();`
`17`	`15`	`public static bool IsLeftMode()`
`18`	`16`	`{`
`19`	`17`	`if (NativeHelper.IsAppPackaged)`
`20`	`18`	`{`
`21`		`- var valueFromSettings = ApplicationData.Current.LocalSettings.Values[IsLeftModeKey];`
	`19`	`+ var valueFromSettings = appData.LocalSettings.Values[SettingsKeys.IsLeftMode];`
`22`	`20`	`if (valueFromSettings == null)`
`23`	`21`	`{`
`24`		`- ApplicationData.Current.LocalSettings.Values[IsLeftModeKey] = true;`
	`22`	`+ appData.LocalSettings.Values[SettingsKeys.IsLeftMode] = true;`
`25`	`23`	`valueFromSettings = true;`
`26`	`24`	`}`
`27`	`25`	`return (bool)valueFromSettings;`
`@@ -37,7 +35,7 @@ public static void IsLeftModeForElement(bool isLeftMode, UIElement element)`
`37`	`35`	`UpdateNavigationViewForElement(isLeftMode, element);`
`38`	`36`	`if (NativeHelper.IsAppPackaged)`
`39`	`37`	`{`
`40`		`- ApplicationData.Current.LocalSettings.Values[IsLeftModeKey] = isLeftMode;`
	`38`	`+ appData.LocalSettings.Values[SettingsKeys.IsLeftMode] = isLeftMode;`
`41`	`39`	`}`
`42`	`40`	`else`
`43`	`41`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`using System;`
`5`	`5`	`using Windows.ApplicationModel;`
`6`	`6`	`using Windows.ApplicationModel.DataTransfer;`
`7`		`-using Windows.Storage;`
	`7`	`+using Microsoft.Windows.Storage;`
`8`	`8`	`using WinUIGallery.Models;`
`9`	`9`
`10`	`10`	`namespace WinUIGallery.Helpers;`
`@@ -14,19 +14,19 @@ namespace WinUIGallery.Helpers;`
`14`	`14`	`/// </summary>`
`15`	`15`	`public static class ProtocolActivationClipboardHelper`
`16`	`16`	`{`
`17`		`- private const string ShowCopyLinkTeachingTipKey = "ShowCopyLinkTeachingTip";`
`18`	`17`	`private static bool _showCopyLinkTeachingTip = true;`
	`18`	`+ private static ApplicationData appData = ApplicationData.GetDefault();`
`19`	`19`
`20`	`20`	`public static bool ShowCopyLinkTeachingTip`
`21`	`21`	`{`
`22`	`22`	`get`
`23`	`23`	`{`
`24`	`24`	`if (NativeHelper.IsAppPackaged)`
`25`	`25`	`{`
`26`		`- object valueFromSettings = ApplicationData.Current.LocalSettings.Values[ShowCopyLinkTeachingTipKey];`
	`26`	`+ object valueFromSettings = appData.LocalSettings.Values[SettingsKeys.ShowCopyLinkTeachingTip];`
`27`	`27`	`if (valueFromSettings == null)`
`28`	`28`	`{`
`29`		`- ApplicationData.Current.LocalSettings.Values[ShowCopyLinkTeachingTipKey] = true;`
	`29`	`+ appData.LocalSettings.Values[SettingsKeys.ShowCopyLinkTeachingTip] = true;`
`30`	`30`	`valueFromSettings = true;`
`31`	`31`	`}`
`32`	`32`	`return (bool)valueFromSettings;`
`@@ -41,7 +41,7 @@ public static bool ShowCopyLinkTeachingTip`
`41`	`41`	`{`
`42`	`42`	`if (NativeHelper.IsAppPackaged)`
`43`	`43`	`{`
`44`		`- ApplicationData.Current.LocalSettings.Values[ShowCopyLinkTeachingTipKey] = value;`
	`44`	`+ appData.LocalSettings.Values[SettingsKeys.ShowCopyLinkTeachingTip] = value;`
`45`	`45`
`46`	`46`	`}`
`47`	`47`	`else`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`// Licensed under the MIT License.`
`3`	`3`
`4`	`4`	`using Microsoft.UI.Xaml;`
`5`		`-using Windows.Storage;`
	`5`	`+using Microsoft.Windows.Storage;`
`6`	`6`
`7`	`7`	`namespace WinUIGallery.Helpers;`
`8`	`8`
`@@ -11,7 +11,7 @@ namespace WinUIGallery.Helpers;`
`11`	`11`	`/// </summary>`
`12`	`12`	`public static class ThemeHelper`
`13`	`13`	`{`
`14`		`- private const string SelectedAppThemeKey = "SelectedAppTheme";`
	`14`	`+ private static ApplicationData appData = ApplicationData.GetDefault();`
`15`	`15`
`16`	`16`	`/// <summary>`
`17`	`17`	`/// Gets the current actual theme of the app based on the requested theme of the`
`@@ -65,7 +65,7 @@ public static ElementTheme RootTheme`
`65`	`65`
`66`	`66`	`if (NativeHelper.IsAppPackaged)`
`67`	`67`	`{`
`68`		`- ApplicationData.Current.LocalSettings.Values[SelectedAppThemeKey] = value.ToString();`
	`68`	`+ appData.LocalSettings.Values[SettingsKeys.SelectedAppTheme] = value.ToString();`
`69`	`69`	`}`
`70`	`70`	`}`
`71`	`71`	`}`
`@@ -74,7 +74,7 @@ public static void Initialize()`
`74`	`74`	`{`
`75`	`75`	`if (NativeHelper.IsAppPackaged)`
`76`	`76`	`{`
`77`		`- string savedTheme = ApplicationData.Current.LocalSettings.Values[SelectedAppThemeKey]?.ToString();`
	`77`	`+ string savedTheme = appData.LocalSettings.Values[SettingsKeys.SelectedAppTheme]?.ToString();`
`78`	`78`
`79`	`79`	`if (savedTheme != null)`
`80`	`80`	`{`