Oakrey.Applications.About 6.0.0

Oakrey.Applications.About

A WPF/.NET 10 library that provides a ready-to-use About dialog for desktop applications. It covers application identity display, loaded assembly/module version listing, RTF EULA rendering, and a Report Issue form with direct log folder access.

Main features

• Application info display � binds application Name, Version, and current Year from IApplicationInfo
• Module version listing � enumerates all loaded assemblies/modules in the current AppDomain; optionally filters out System.* and Microsoft.* assemblies via SystemModuleVisible
• RTF EULA rendering � reads Assets/eula.rtf at startup, converts it to plain text, and exposes it for binding; gracefully handles missing or unreadable files with logged warnings
• Report Issue form � a WPF DarkWindow dialog that exposes the application log directory path and allows the user to open the log folder in Explorer
• MVVM-ready ViewModel � AboutViewModel implements INotifyPropertyChanged and IAutoConfigurable; provides a ReportIssue ICommand
• Telemetry � all ViewModel and service operations are traced via Oakrey.Telemetry

Architecture

classDiagram
    IAboutService <|.. AboutService
    AboutService --> ModuleVersion : produces
    AboutViewModel --> IAboutService : consumes
    AboutViewModel --> IApplicationInfo : consumes
    AboutViewModel --> ReportIssueForm : opens on command
    ReportIssueForm --> IApplicationInfo : reads LogDirectoryPath

Requirements

• .NET 10 (Windows)
• WPF host application
• Oakrey.ViewModels >= 2.1.0
• Oakrey.Telemetry >= 2.0.1
• Oakrey.Applications (provides IApplicationInfo)

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.About and click Install.

.NET CLI

dotnet add package Oakrey.Applications.About

Package Manager Console

Install-Package Oakrey.Applications.About

Configuration

Register the About services during application startup:

services.AddSingleton<IAboutService, AboutService>();
services.AddTransient<ReportIssueForm>();
// AboutViewModel is resolved by the ViewModelProvider; no explicit registration needed
// if using Oakrey.Applications ViewModelProvider auto-configuration.

AboutService and ReportIssueForm both depend on IApplicationInfo, which must be registered separately.

Example usage

DI setup

services.AddSingleton<IApplicationInfo, MyAppInfo>();
services.AddSingleton<IAboutService, AboutService>();
services.AddTransient<ReportIssueForm>();

XAML page

<Page xmlns:vm="clr-namespace:Oakrey.Applications.About;assembly=Oakrey.Applications.About"
      xmlns:vmp="clr-namespace:Oakrey.Applications;assembly=Oakrey.Applications.Base"
      d:DataContext="{d:DesignInstance Type=vm:AboutViewModel, IsDesignTimeCreatable=True}"
      DataContext="{vmp:ViewModelProvider vm:AboutViewModel}">

    <StackPanel>
        <TextBlock>
            <Run Text="Application: " /><Run Text="{Binding Name, Mode=OneWay}" />
            <LineBreak />
            <Run Text="Version: " /><Run Text="{Binding Version, Mode=OneWay}" />
            <LineBreak />
            <Run Text="Copyright � " /><Run Text="{Binding Year, Mode=OneWay}" />
        </TextBlock>

        <Button Content="Report Issue" Command="{Binding ReportIssue}" />

        <TextBlock Text="{Binding EulaRtf, Mode=OneWay}" TextWrapping="Wrap" />

        <DataGrid ItemsSource="{Binding Modules}" AutoGenerateColumns="False" IsReadOnly="True">
            <DataGrid.Columns>
                <DataGridTextColumn Header="Module" Binding="{Binding Name}" />
                <DataGridTextColumn Header="Version" Binding="{Binding Version}" />
            </DataGrid.Columns>
        </DataGrid>
    </StackPanel>
</Page>

EULA file placement

Place the EULA as an RTF file in the application output directory:

{AppBaseDirectory}/
  Assets/
    eula.rtf

If the file is missing, AboutViewModel logs a warning and sets EulaRtf to "EULA file not found.".

Development notes

• AboutViewModel has a default parameterless constructor that uses new AboutService() and new DummyAppInfo() to support design-time rendering in Visual Studio. It logs a warning when this path is taken.
• AboutService.SystemModuleVisible defaults to true. Set it to false before first access to Modules to suppress System.* and Microsoft.* assemblies from the list. The result is lazy-evaluated and cached.
• ReportIssueForm inherits from DarkWindow (from Oakrey.Applications.UI). It opens the log directory via explorer.exe using Process.Start with UseShellExecute = true.

License

MIT � Copyright � Oakrey 2016-present

• Repository: ApplicationServices
• Project URL: oakrey.cz

License

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