Oakrey.Applications.Settings 5.1.5

Oakrey.Applications.Settings

WPF-only (.NET 10, Windows) library providing persistent and volatile typed key-value settings backed by JSON, bindable SettingsBase view-model integration, automatic CallerMemberName key inference, built-in window-bounds restore, and a one-call DI registration extension.

Main features

• ISettingsService / ISettingsService<T> - typed, generic service for loading, saving and querying settings per settings class.
• Persistent and volatile settings - persistent settings survive application restarts; volatile settings are held in memory only for the current session.
• SettingsBase - abstract base class deriving from ViewModelBase; combines ISettingsService with INotifyPropertyChanged so settings properties bind directly in WPF.
• CallerMemberName key inference - Get<T>() and Set<T>() use the calling property name as the storage key automatically; no magic strings required.
• RestoreBounds - ready-made settings class that stores and restores Top, Left, Width, Height for a Window, with sensible minimum-value guards.
• RestoreBoundExtension - ApplyRestoreBounds and SaveRestoreBounds extension methods on System.Windows.Window.
• JSON backing - settings are serialized to and loaded from JSON via IJsonSettingService; each settings class occupies its own section keyed by its full type name.
• DI registration - single ConfigureSettingService(IServiceCollection) call registers all required services.
• Logging and tracing - integrated with Oakrey.Log and Oakrey.Telemetry.Tracing.

Architecture

classDiagram
    class ISettingsService {
        +Get~TValue~(key) TValue
        +GetVolatile~TValue~(key) TValue
        +Set~TValue~(value, key)
        +SetVolatile~TValue~(value, key)
        +Load()
        +Save()
        +AppSettingPath string
    }
    class SettingsService~TSetting~ {
        -settingsStorage Dictionary
        -volatileSettingsStorage Dictionary
        -jsonService IJsonSettingService
    }
    class SettingsBase {
        #Get~TValue~(key) TValue
        #Set~TValue~(value, key)
        #GetVolatile~TValue~(key) TValue
        #SetVolatile~TValue~(value, key)
    }
    class RestoreBounds {
        +Top int
        +Left int
        +Width int
        +Height int
    }

    ISettingsService <|.. SettingsService~TSetting~
    SettingsBase --> ISettingsService
    RestoreBounds --|> SettingsBase

Requirements

• .NET 10 Windows (WPF)
• Package references: Oakrey.Log, Oakrey.ViewModels
• Project references (when used from source): Json, Application, ViewModels

Installation

NuGet Package Manager

1. Open the project in Visual Studio.
2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution.
3. Search for Oakrey.Applications.Settings and install.

.NET CLI

dotnet add package Oakrey.Applications.Settings

Package Manager Console

Install-Package Oakrey.Applications.Settings

Configuration

Register all required services with a single call in your DI setup:

services.ConfigureSettingService();

This registers IFileService, IJsonSettingService, and the open-generic ISettingsService<>.

Example usage

Custom settings class

public sealed class AppSettings(ISettingsService<AppSettings> settingsService)
    : SettingsBase(settingsService)
{
    public string Theme
    {
        get => Get<string>() ?? "Dark";
        set => Set(value);
    }

    public bool ShowToolbar
    {
        get => Get<bool>();
        set => Set(value);
    }
}

Register with DI:

services.ConfigureSettingService();
services.AddTransient<AppSettings>();

Window bounds restore

// In Window.Loaded
window.ApplyRestoreBounds(restoreBounds);

// In Window.Closing
window.SaveRestoreBounds(restoreBounds);

Register RestoreBounds in DI (it is resolved via ISettingsService<RestoreBounds>):

services.ConfigureSettingService();
services.AddTransient<RestoreBounds>();

Development notes

• Settings are stored per type: the full type name of TSetting is used as the JSON section key.
• Default settings are loaded first; user-overrides are merged on top.
• SettingsService<T> implements IDisposable; Dispose() triggers a final Save().
• RestoreBounds enforces a minimum of 100 px for position and 768 px for dimensions.
• Volatile settings are not persisted to disk and are cleared on dispose.

Project information

License

This project is licensed under the MIT License. See the LICENSE file for details.