XFormSettings

A nuget to improve settings storage (locally and eventually in the cloud) on .NETStandard Xamarin.Forms projects. There is also an Maui version, which can be found here. https://github.com/AndreasReitberger/MauiSettings

The plugin idea is based on the Advexp.Settings.Local nuget by Alexey Ivakin
Repo: https://bitbucket.org/advexp/component-advexp.settings/src/master/
License: Apache-2.0 (https://licenses.nuget.org/Apache-2.0)

This project was created from scratch, however uses the basic idea to keep all Settings in the static object. All taken and changed files have been marked so.

Support me

If you want to support me, you can order over following affilate links (I'll get a small share from your purchase from the corresponding store).

• Prusa: http://www.prusa3d.com/#a_aid=AndreasReitberger *
• Jake3D: https://tidd.ly/3x9JOBp *
• Amazon: https://amzn.to/2Z8PrDu *

(*) Affiliate link Thank you very much for supporting me!

Nuget

Get the latest version from nuget.org

Usage

Settings Object

In the .NET MAUI project, create a new Class (for instance SettingsApp.cs) holding your setting properties.

public partial class SettingsApp : XFormSettings<SettingsApp>
{
    
    #region Settings

    #region Version
    [XFormSetting(Name = nameof(App_SettingsVersion))]
    public static Version App_SettingsVersion { get; set; } = new("1.0.0");

    #endregion

    #region CloudSync
    [XFormSetting(Name = nameof(Cloud_ShowInitialPrompt), DefaultValue = true)]
    public static bool Cloud_ShowInitialPrompt { get; set; }

    [XFormSetting(Name = nameof(Cloud_ShowInitialPrompt), DefaultValue = SettingsStaticDefault.Cloud_EnableSync)]
    public static bool Cloud_EnableSync { get; set; }
    #endregion

    #region Theme 
    [XFormSetting(Name = nameof(Theme_UseDeviceDefaultSettings), DefaultValue = SettingsStaticDefault.General_UseDeviceSettings)]
    public static bool Theme_UseDeviceDefaultSettings { get; set; }

    [XFormSetting(Name = nameof(Theme_UseDarkTheme), DefaultValue = SettingsStaticDefault.General_UseDarkTheme)]
    public static bool Theme_UseDarkTheme { get; set; }

    [XFormSetting(Name = nameof(Theme_PrimaryThemeColor), DefaultValue = SettingsStaticDefault.Theme_PrimaryThemeColor)]
    public static string Theme_PrimaryThemeColor { get; set; }

    #endregion

    #region Localization

    [XFormSetting(Name = nameof(Localization_CultureCode), DefaultValue = SettingsStaticDefault.Localization_Default)]
    public static string Localization_CultureCode { get; set; }

    #endregion

    #endregion
}

Load

To load the settings from the storage, call SettingsApp.LoadSettings() (mostly in the App constructor of your App.xmls file. The project uses the Xamarin.Essentials.Preferences in order to store the settings on the corresponding device.

Save

Whenever you do make changes to a settings property of your class, call SettingsApp.SaveSettings(). This will write the settings to the storage.