Oakrey.Applications.SplashScreen 4.0.3

Oakrey.Applications.SplashScreen

A .NET 10 WPF library that provides an async splash screen for Windows desktop applications. It runs arbitrary preload tasks in parallel, optionally checks for MSI updates, and returns a SplashResult that drives the application startup flow.

Main features

• ISplashScreenService abstraction for showing the splash screen and awaiting startup completion.
• SplashScreenService<T> generic implementation where T is the entry-point assembly marker used by MsiDeployment<T>.
• Parallel execution of any number of preload Task instances while the splash is visible.
• Integrated MSI update flow: checks for update, shows update progress in a second splash window, and shuts down after applying.
• SplashResult enum communicating the outcome (NoUpdateAvailable, UpdateSkipped, UpdateRequested, ShutdownRequested).
• ISplashScreenService extends ILoggerEngine � any ILogger.Information call forwarded through the service updates the on-screen loading text.
• SplashScreenConfigurationExtension for one-line DI registration.
• Integrated Oakrey.Log logging and Oakrey.Telemetry activity tracing throughout the startup flow.

Project structure

SplashScreen/
  ISplashScreenService.cs                 # Service abstraction (extends ILoggerEngine)
  SplashScreenService.cs                  # Generic implementation with MSI update support
  SplashWindow.xaml / .xaml.cs           # WPF splash window (INPC, async ShowAsync)
  SplashscreenConfigurationExtension.cs  # IServiceCollection extension
  SplashResult.cs                         # Enum describing startup outcome

Startup flow

flowchart TD
    A[App starts] --> B[ShowSplashScreen called]
    B --> C{requireUpdate?}
    C -- No --> D[Run preload tasks]
    C -- Yes --> E[CheckForUpdate + preload tasks in parallel]
    E --> F{Update available?}
    F -- No --> D
    F -- Yes --> G[User sees Update / Skip buttons]
    G -- Skip --> D
    G -- Update --> H[Run MsiDeployment.Update]
    H --> I[Application.Shutdown]
    G -- Close --> J[ShutdownRequested]
    D --> K[Return true - continue startup]
    J --> L[Return false - abort startup]

Requirements

• .NET 10, Windows (net10.0-windows7 or later)
• WPF (UseWPF must be enabled in the consuming project)
• Oakrey.Applications � provides IApplicationInfo and ApplicationInfo
• Oakrey.Msi � MSI deployment and update checking
• Oakrey.Files.Windows � file utilities (transitive)
• Oakrey.Wpf.Converters � WPF value converters used by SplashWindow

Installation

NuGet Package Manager

1. Open your project in Visual Studio.
2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution.
3. Search for Oakrey.Applications.SplashScreen and click Install.

.NET CLI

dotnet add package Oakrey.Applications.SplashScreen

Package Manager Console

Install-Package Oakrey.Applications.SplashScreen

Configuration

Register the service in your DI container. The generic parameter T must be a class from the entry-point assembly so that MsiDeployment<T> can locate the installed product:

services.ConfigureSplashScreenService<App>();

IApplicationInfo must also be registered. SplashScreenService<T> resolves it from the container to populate the window title, version label, and logo.

Example usage

Typical placement is in App.xaml.cs before the main window is shown:

public partial class App : Application
{
    protected override async void OnStartup(StartupEventArgs e)
    {
        ServiceProvider provider = ConfigureServices();

        ISplashScreenService splash = provider.GetRequiredService<ISplashScreenService>();

        bool continueStartup = await splash.ShowSplashScreen(
            requireUpdate: true,
            preloadFunction: LoadSettingsAsync(), LoadCacheAsync());

        if (!continueStartup)
        {
            Shutdown();
            return;
        }

        MainWindow mainWindow = provider.GetRequiredService<MainWindow>();
        mainWindow.Show();
    }
}

SplashResult values

Development notes

• SplashScreenService<T> uses DummyAppInfo when constructed without DI (parameterless constructor), logging a warning. This is intended for design-time and testing scenarios only.
• The ILoggerEngine.Log override only reacts to Level.Information; other log levels are ignored by the splash window text binding.
• Update progress is shown in a second SplashWindow instance created with an "{AppName} Update" title and the downloaded version string.

License

MIT. See the LICENSE file for details.