Xamarin.Forms UWP project migration

Artikel
12/29/2023

To update your Xamarin.Forms UWP project to a WinUI 3 project, you should:

Update your project file to be SDK-style.
Update namespaces
Address any API changes
Update or replace incompatible dependencies with .NET 8 versions.
Compile and test your app.

Update to an SDK-style project file

Your existing Xamarin.Forms UWP project can be updated to an SDK-style WinUI 3 project in place. An SDK-style project for a .NET MAUI WinUI 3 app is similar to the following example:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>WinExe</OutputType> <!-- in Xamarin.Forms this was AppContainerExe -->
    <TargetFramework>net8.0-windows10.0.19041.0</TargetFramework>
    <TargetPlatformMinVersion>10.0.17763.0</TargetPlatformMinVersion>
    <RootNamespace>YOUR_NAMESPACE_HERE.WinUI</RootNamespace>
    <ApplicationManifest>app.manifest</ApplicationManifest>
    <Platforms>x86;x64;ARM64</Platforms>
    <RuntimeIdentifiers>win10-x86;win10-x64;win10-arm64</RuntimeIdentifiers>
    <UseWinUI>true</UseWinUI>
    <EnableMsixTooling>true</EnableMsixTooling>
    <UseMaui>true</UseMaui>
    <!-- We do not want XAML files to be processed as .NET MAUI XAML -->
    <EnableDefaultMauiItems>false</EnableDefaultMauiItems>
  </PropertyGroup>
  ...
</Project>

Important

The target framework moniker (TFM) is what denotes the project as using .NET, in this case .NET 8. For information about target frameworks in SDK-style projects, see Target frameworks in SDK-style projects.

You must add <UseMaui>true</UseMaui> to your project file to enable .NET MAUI support. In addition, ensure you've added <EnableDefaultMauiItems>false</EnableDefaultMauiItems> to the project file. This will stop you receiving build errors about the InitializeComponent method already being defined.

Changes to MSBuild properties

While upgrading your project, it's recommended to remove the following UWP MSBuild properties from your project file:

WindowsXamlEnableOverview
AppxPackageSigningEnabled
GenerateAssemblyInfo

You'll also need to ensure that the platform architectures in the target project are specified with the following .NET runtime identifiers:

<PropertyGroup>
   <!-- Used in .NET MAUI WinUI projects -->
   <Platforms>x86;x64;ARM64</Platforms>
</PropertyGroup>

For more information about runtime identifiers, see .NET RID Catalog.

Namespace changes

There are differences in the names of namespaces between UWP and WinUI 3. In many cases it's as easy as changing a namespace name and then your code will compile. For example, you'll need to replace the Windows.UI.Xaml namespace with the Microsoft.UI.Xaml namespace. Similarly, you'll need to replace the Windows.UI.Xaml.Controls namespace with the Microsoft.UI.Xaml.Controls namespace.

Other times, the mapping takes a bit more work, and in rare cases requires a change in approach. For more information, see Mapping UWP APIs and libraries to the Windows App SDK.

API changes

You'll need to address any API changes that may affect your app. For example, some types, methods, and properties may have been renamed, deprecated or removed. For information on what's supported when upgrading your UWP project to WinUI 3, see What's supported when migrating from UWP to WinUI 3. For information about mapping UWP features and APIs to WinUI 3, see Mapping UWP features to the Windows App SDK and Mapping UWP APIs and libraries to the Windows App SDK.

Your project can be made compatible with earlier OS versions by setting the $(SupportedOSPlatformVersion) property in your project file:

<PropertyGroup>
   <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'windows'">10.0.19041.0</SupportedOSPlatformVersion>
</PropertyGroup>

The $(SupportedOSPlatformVersion) property indicates the minimum OS version required to run your app or library. If you don't explicitly specify this minimum runtime OS version in your project, it defaults to the platform version from the Target Framework Moniker (TFM).

If your project only targets Windows, it's sufficient to omit the platform checking condition and set the $(SupportedOSPlatformVersion) property directly:

<PropertyGroup>
   <SupportedOSPlatformVersion>10.0.19041.0</SupportedOSPlatformVersion>
</PropertyGroup>

For more information about the $(SupportedOSPlatformVersion) property, see Support older OS versions.

For an app to run correctly on an older OS version, it can't call APIs that don't exist on that version of the OS. However, you can add guards around calls to newer APIs so they are only called when running on a version of the OS that supports them. This can be achieved with the IsWindowsVersionAtLeast method:

if (OperatingSystem.IsWindowsVersionAtLeast(10))
{
    // Use the API here
}

Remove files

The following files, which are present in Xamarin.Forms UWP projects, don't exist in WinUI 3 projects:

MainPage.xaml and MainPage.xaml.cs
AssemblyInfo.cs
Default.rd.xml

Therefore, you should remove these files if they're in your WinUI 3 project. Any required business logic contained in these files should be moved elsewhere.

Changes to Package.appxmanifest

The following changes must be made to your migrated project's Package.appxmanifest file:

Set the application entry point to $targetentrypoint$ . For more information, see Target entry point.
Add the runFullTrust capability. For more information, see Run full trust capability.
Add the Windows.Universal and Windows.Desktop target device families. For more information, see Universal target device family and Desktop target device family.

Making these changes fixes common deployment errors for your app on Windows.

For an example of a compliant Package.appxmanifest file, see Package.appxmanifest.

Runtime behavior

There are behavioral changes to the String.IndexOf() method in .NET 5+ on different platforms. For more information, see .NET globalization and ICU.

Next steps

Bootstrap your app

Dela via