👁 Image
DSoft.System.Mvvm.UI.WinUI 3.6.2606.131

System.Mvvm.UI.WinUI

Provides Win UI 3 platform implementations for DSoft.System.Mvvm.UI

Functionality

• Core UI functions for Showing Alerts and Confirmation Dialogs
• UI Thread execution
• Dependency injection support with IPlatformCoreUIProvider
• Works with Win UI 3 (Windows App SDK 1.0 and above) on .NET 10
  • Windows 10 version 2004 (19041) and above

Using System.Mvvm.UI.WinUI

The UI static class provides four methods as defined in the IPlatformCoreUIProvider interface.

• A central interface for calling some simple UI functions
  • ShowAlert(string title, string message)
    • Show an alert with a title and message using the platform implementation
  • ShowConfirmation(string title, string message)
    • Show a confirmation dialog and return the result using the platform implementation
  • InvokeOnUIThread(Action)
    • Execute the action on the UI thread using the platform implementation
  • InvokeOnUIThreadAsync(Action)
    • Execute the action on the UI thread asyncronously using the platform implementation

The standard UI functions can be called directly after adding the DSoft.Mvvm.UI package to your shared code

using System.Mvvm;
... 

var result = await UI.ShowConfirmationDialogAsync("Confirm this", "This is a platform specific confirmation message");

if (result)
 await UI.ShowAlertAsync("YAY!", "You confirmed that");

In the WinUI application project that contains the App class(or other sub-class of Application) to the application, add the DSoft.System.Mvvm.UI.WinUI package.

Call the MvvmManager.Init method in the application code, such as App constructor.

using System.Mvvm;
... 
public partial class App : Application
{
 public App()
 {
 this.InitializeComponent();
 this.Suspending += OnSuspending;

 MvvmManager.Init();

 }
}

Dependency Injection

Instead of using the static UI class you can use dependency injection to access the platform implementation of IPlatformCoreUIProvider using extensions for IServiceCollection provided by the platform specific packages.

After adding DSoft.System.Mvvm.UI.WinUI to the application project you can register the core UI implementations of IPlatformCoreUIProvider with the ServiceProvider during configuration of the services using the AddCoreUI extension method.

using System.Mvvm;
... 
public partial class App : Application
{
 public App()
 {
 this.InitializeComponent();

 ServiceHost.Host = new HostBuilder()
 .ConfigureServices(ConfigureServices)
 .Build();
 }

 void ConfigureServices(HostBuilderContext ctx, IServiceCollection services)
 {
 services.AddCoreUI();
 }
}

Once the core UI is registered you can use IPlatformCoreUIProvider with dependency injection in class constructors.

using System.Mvvm;
... 
public class SharedClassToDoThingsIn
{
 private readonly IPlatformCoreUIProvider _coreUIProvider;

 public SharedClassToDoThingsIn(IPlatformCoreUIProvider coreUIProvider)
 {
 _coreUIProvider = coreUIProvider;
 }

 public async Task SayHello()
 {
 await _coreUIProvider.ShowAlertAsync("Congrats", "You called the ICoreUIProvider instance");
 }
}

Use can also retrieve the implementation directly from the services provider or ServiceHost if you are using DSoft.System.Mvvm.Hosting

using System.Mvvm;
... 
var _coreUIProvider = ServiceHost.GetRequiredService<IPlatformCoreUIProvider>();

await _coreUIProvider.ShowAlertAsync("Congrats", "You called the ICoreUIProvider instance");

Using DI instead of the UI does not require a call to MvvmManager.Init though you do have to call the extension method to register the services. You can also use both.