MauiWindowsExtensions Methods

Docs / Reference / Search C# APIs / Aspire.Hosting.Maui / MauiWindowsExtensions / Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting.Maui MauiWindowsExtensions Methods

Class Methods 2 members

Provides extension methods for adding Windows platform resources to MAUI projects.

AddWindowsDevice(IResourceBuilder<MauiProjectResource>) extension IResourceBuilder<MauiWindowsPlatformResource>

Adds a Windows device resource to run the MAUI application on the Windows platform.

public static class MauiWindowsExtensions
{
    public static IResourceBuilder<MauiWindowsPlatformResource> AddWindowsDevice(
        this IResourceBuilder<MauiProjectResource> builder)
    {
        // ...
    }
}

MauiWindowsExtensions.cs#L41-L44

Parameters

builder IResourceBuilder<MauiProjectResource> The MAUI project resource builder.

Returns

IResourceBuilder<MauiWindowsPlatformResource> A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This method creates a new Windows platform resource that will run the MAUI application targeting the Windows platform using dotnet run. The resource does not auto-start and must be explicitly started from the dashboard by clicking the start button.

The resource name will default to "{projectName}-windows".

Examples

Add a Windows device to a MAUI project:

var builder = DistributedApplication.CreateBuilder(args);

var maui = builder.AddMauiProject("mauiapp", "../MyMauiApp/MyMauiApp.csproj");
var windowsDevice = maui.AddWindowsDevice();

builder.Build().Run();

AddWindowsDevice(IResourceBuilder<MauiProjectResource>, string) extension IResourceBuilder<MauiWindowsPlatformResource>

Adds a Windows device resource to run the MAUI application on the Windows platform with a specific name.

public static class MauiWindowsExtensions
{
    public static IResourceBuilder<MauiWindowsPlatformResource> AddWindowsDevice(
        this IResourceBuilder<MauiProjectResource> builder,
        string name)
    {
        // ...
    }
}

MauiWindowsExtensions.cs#L77-L103

Parameters

builder IResourceBuilder<MauiProjectResource> The MAUI project resource builder.

name string The name of the Windows device resource.

Returns

IResourceBuilder<MauiWindowsPlatformResource> A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This method creates a new Windows platform resource that will run the MAUI application targeting the Windows platform using dotnet run. The resource does not auto-start and must be explicitly started from the dashboard by clicking the start button.

You can add multiple Windows device resources to a MAUI project by calling this method multiple times with different names.

Examples

Add multiple Windows devices to a MAUI project:

var builder = DistributedApplication.CreateBuilder(args);

var maui = builder.AddMauiProject("mauiapp", "../MyMauiApp/MyMauiApp.csproj");
var windowsDevice1 = maui.AddWindowsDevice("windows-device-1");
var windowsDevice2 = maui.AddWindowsDevice("windows-device-2");

builder.Build().Run();