WinUI3Utilities 1.1.3.2

WinUI3Utilities

Useful template methods for WinUI3 projects

Build

Usage

The following is the general usage. For more details, see the XAML docs of the corresponding attributes.

Initialize the CurrentContext

It is recommended to assign the CurrentContext.Window in the first line of the MainWindow's constructor, because it is possible that other methods in the program will call CurrentContext.Window before the end of the constructor. This will avoid unassigned exceptions.

App.xaml.cs:

using Microsoft.UI.Xaml;
using WinUI3Utilities;

namespace Sample;

public partial class App : Application
{
    public App()
    {
        InitializeComponent();
        CurrentContext.Title = nameof(Sample);
    }

    protected override void OnLaunched(LaunchActivatedEventArgs args)
    {
        _ = new MainWindow();
        AppHelper.Initialize(new()
        {
            Size = WindowHelper.EstimatedWindowSize(),
            ...
        });
    }
}

MainWindow.xaml.cs:

using Microsoft.UI.Xaml;
using WinUI3Utilities;

namespace Sample;

public sealed partial class MainWindow : Window
{
    public MainWindow()
    {
        CurrentContext.Window = this;
        InitializeComponent();
    }
}

Settings Persistence

Only for packaged applications.

AppContext.cs:

using Windows.Storage;
using WinUI3Utilities.Attributes;

namespace Sample;

[AppContext<AppConfig>]
public static partial class AppContext
{
    public static string AppLocalFolder { get; private set; } = null!;

    public static void Initialize()
    {
        AppLocalFolder = ApplicationData.Current.LocalFolder.Path;
        InitializeConfigurationContainer();
        AppConfig = LoadConfiguration() is not { } appConfigurations)
            ? new() : appConfigurations;
    }

    public static void SetDefaultAppConfig() => AppConfig = new();

    public static AppConfig AppConfig { get; private set; } = null!;
}

AppConfig.cs:

using WinUI3Utilities.Attributes;

namespace Sample;

[GenerateConstructor]
public partial record AppConfig
{
    public int WindowWidth { get; set; } = 1280;
    public int WindowHeight { get; set; } = 720;
    ...
}

When saving configuration, you can use the following code:

AppContext.SaveConfiguration(AppContext.AppConfig)

Localization

Generate all the .resw files under the specified namespace.

Reference

Sample.csproj

<Project Sdk="Microsoft.NET.Sdk">
    ... 
    <PropertyGroup>
        <EnableDefaultPriItems>false</EnableDefaultPriItems>
    </PropertyGroup>
    <Target Name="InjectAdditionalFiles" BeforeTargets="GenerateMSBuildEditorConfigFileShouldRun">
        <ItemGroup>
            <AdditionalFiles Include="@(PRIResource)" SourceItemGroup="PRIResource" />
        </ItemGroup>
    </Target>
    <ItemGroup>
        <CompilerVisibleItemMetadata Include="AdditionalFiles" MetadataName="SourceItemGroup" />
    </ItemGroup>
    ...
    <ItemGroup>
        <PRIResource Include="XXX\APage.resw" />
        <PRIResource Include="XXX\BWindow.resw" />
    </ItemGroup>
    ...
</Project>

AssemblyInfo.cs:

[assembly: LocalizedStringResources(nameof(Sample))]

XXX\APage.resw: ...

XXX\BWindow.resw: ...

Project Link

Contact Me

License

MIT License