Windows Form App For Mac
This article describes how to port your Windows Forms-based desktop app from .NET Framework to .NET Core 3.0 or later. The .NET Core 3.0 SDK includes support for Windows Forms applications. Windows Forms is still a Windows-only framework and only runs on Windows. This example uses the .NET Core SDK CLI to create and manage your project.
In this article, various names are used to identify types of files used for migration. When migrating your project, your files will be named differently, so mentally match them to the ones listed below:
File | Description |
---|---|
MyApps.sln | The name of the solution file. |
MyForms.csproj | The name of the .NET Framework Windows Forms project to port. |
MyFormsCore.csproj | The name of the new .NET Core project you create. |
MyAppCore.exe | The .NET Core Windows Forms app executable. |
Prerequisites
Visual Studio 2019 16.5 Preview 1 or later for any designer work you want to do. We recommend to update to the latest Preview version of Visual Studio.
Install the following Visual Studio workloads:
- .NET desktop development
- .NET Core cross-platform development
A working Windows Forms project in a solution that builds and runs without issue.
A project coded in C#.
Note
- Form Builder Software Comparison. Use GetApp to find the best Form Builder software and services for your needs. Our intuitive directory allows you to make an easy online Form Builder software comparison in just a few minutes by filtering by deployment method (such as Web-based, Cloud Computing or Client-Server), operating system (including Mac, Windows, Linux, iOS, Android), pricing.
- So, for running DataScope Forms on your Windows or Mac based system, you can either use BlueStacks or Nox App Player which both are the known and fully trusted Android Emulators readily available. Download Nox App Player Download BlueStacks Running DataScope Forms Using BlueStacks.
- This latest version crashes (on the Mac) if I type too fast in Visual Studio on my Windows Desktop at work. I get the spinning beachball- have to exit to the Mac, force quit MRD and restart it, then reconnect. I'm finding myself doing this at least 2 or 3 times per hour!
- Feb 17, 2020 Google Forms and SurveyHeart forms can be Created using FormsApp easily. Create Google Forms and Edit on the Go. Create Forms easily by using following Templates, - Job Application Form - Contact Information Form - Event Registration Form - Event Feedback Form - Order Request Form - Time off Request Form - Work Request Form - Customer Feedback Form - Exit ticket Form - Assessment Form.
Introduced FormsApp for Google Forms application to work with Android operating system or iOS even so, you might also install FormsApp for Google Forms on PC or laptop. We shall find out the specifications for you to download FormsApp for Google Forms PC on Windows or MAC computer without much struggle.
.NET Core 3.0 projects are only supported in Visual Studio 2019 or a later version. Starting with Visual Studio 2019 version 16.5 Preview 1, the .NET Core Windows Forms designer is also supported.
To enable the designer, go to Tools > Options > Environment > Preview Features and select the Use the preview Windows Forms designer for .NET Core apps option.
Consider
When porting a .NET Framework Windows Forms application, there are a few things you must consider.
Check that your application is a good candidate for migration.
Use the .NET Portability Analyzer to determine if your project will migrate to .NET Core 3.0. If your project has issues with .NET Core 3.0, the analyzer helps you identify those problems.
You're using a different version of Windows Forms.
When .NET Core 3.0 Preview 1 was released, Windows Forms went open source on GitHub. The code for .NET Core Windows Forms is a fork of the .NET Framework Windows Forms codebase. It's possible some differences exist and your app won't port.
The Windows Compatibility Pack may help you migrate.
Some APIs that are available in .NET Framework aren't available in .NET Core 3.0. The Windows Compatibility Pack adds many of these APIs and may help your Windows Forms app become compatible with .NET Core.
Update the NuGet packages used by your project.
It's always a good practice to use the latest versions of NuGet packages before any migration. If your application is referencing any NuGet packages, update them to the latest version. Ensure your application builds successfully. After upgrading, if there are any package errors, downgrade the package to the latest version that doesn't break your code.
Create a new SDK project
The new .NET Core 3.0 project you create must be in a different directory from your .NET Framework project. If they're both in the same directory, you may run into conflicts with the files that are generated in the obj directory. In this example, we'll create a directory named MyFormsAppCore in the SolutionFolder directory:
Next, you need to create the MyFormsCore.csproj project in the MyFormsAppCore directory. You can create this file manually by using the text editor of choice. Paste in the following XML:
If you don't want to create the project file manually, you can use Visual Studio or the .NET Core SDK to generate the project. However, you must delete all other files generated by the project template except for the project file. To use the SDK, run the following command from the SolutionFolder directory:
After you create the MyFormsCore.csproj, your directory structure should look like the following:
Convert Windows App To Mac
Add the MyFormsCore.csproj project to MyApps.sln with either Visual Studio or the .NET Core CLI from the SolutionFolder directory:
Fix assembly info generation
Windows Forms projects that were created with .NET Framework include an AssemblyInfo.cs
file, which contains assembly attributes such as the version of the assembly to be generated. SDK-style projects automatically generate this information for you based on the SDK project file. Having both types of 'assembly info' creates a conflict. Resolve this problem by disabling automatic generation, which forces the project to use your existing AssemblyInfo.cs
file.
There are three settings to add to the main <PropertyGroup>
node.
GenerateAssemblyInfo
When you set this property tofalse
, it won't generate the assembly attributes. This avoids the conflict with the existingAssemblyInfo.cs
file from the .NET Framework project.AssemblyName
The value of this property is the output binary created when you compile. The name doesn't need an extension added to it. For example, usingMyCoreApp
producesMyCoreApp.exe
.RootNamespace
The default namespace used by your project. This should match the default namespace of the .NET Framework project.
Add these three elements to the <PropertyGroup>
node in the MyFormsCore.csproj
file:
Add source code
Right now, the MyFormsCore.csproj project doesn't compile any code. By default, .NET Core projects automatically include all source code in the current directory and any child directories. You must configure the project to include code from the .NET Framework project using a relative path. If your .NET Framework project used .resx files for icons and resources for your forms, you'll need to include those too.
Add the following <ItemGroup>
node to your project. Each statement includes a file glob pattern that includes child directories.
Alternatively, you can create a <Compile>
or <EmbeddedResource>
entry for each file in your .NET Framework project.
Add NuGet packages
Add each NuGet package referenced by the .NET Framework project to the .NET Core project.
Most likely your .NET Framework Windows Forms app has a packages.config file that contains a list of all of the NuGet packages that are referenced by your project. Best design software for mac. You can look at this list to determine which NuGet packages to add to the .NET Core project. For example, if the .NET Framework project referenced the MetroFramework
, MetroFramework.Design
, and MetroFramework.Fonts
NuGet packages, add each to the project with either Visual Studio or the .NET Core CLI from the SolutionFolder directory:
The previous commands would add the following NuGet references to the MyFormsCore.csproj project:
Port control libraries
If you have a Windows Forms Controls library project to port, the directions are the same as porting a .NET Framework Windows Forms app project, except for a few settings. And instead of compiling to an executable, you compile to a library. The difference between the executable project and the library project, besides paths for the file globs that include your source code, is minimal.
Using the previous step's example, lets expand what projects and files we're working with.
File | Description |
---|---|
MyApps.sln | The name of the solution file. |
MyControls.csproj | The name of the .NET Framework Windows Forms Controls project to port. |
MyControlsCore.csproj | The name of the new .NET Core library project you create. |
MyCoreControls.dll | The .NET Core Windows Forms Controls library. |
Consider the differences between the MyControlsCore.csproj
project and the previously created MyFormsCore.csproj
project.
Here is an example of what the .NET Core Windows Forms Controls library project file would look like:
As you can see, the <OutputType>
node was removed, which defaults the compiler to produce a library instead of an executable. The <AssemblyName>
and <RootNamespace>
were changed. Specifically the <RootNamespace>
should match the namespace of the Windows Forms Controls library you are porting. And finally, the <Compile>
and <EmbeddedResource>
nodes were adjusted to point to the folder of the Windows Forms Controls library you are porting.
Next, in the main .NET Core MyFormsCore.csproj project, add a reference to the new .NET Core Windows Forms Control library. Add a reference with either Visual Studio or the .NET Core CLI from the SolutionFolder directory:
The previous command adds the following to the MyFormsCore.csproj project:
Compilation problems
If you have problems compiling your projects, you may be using some Windows-only APIs that are available in .NET Framework but not available in .NET Core. You can try adding the Windows Compatibility Pack NuGet package to your project. This package only runs on Windows and adds about 20,000 Windows APIs to .NET Core and .NET Standard projects.
The previous command adds the following to the MyFormsCore.csproj project:
Windows Forms Designer
As detailed in this article, Visual Studio 2019 only supports the Forms Designer in .NET Framework projects. By creating a side-by-side .NET Core project, you can test your project with .NET Core while you use the .NET Framework project to design forms. Your solution file includes both the .NET Framework and .NET Core projects. Add and design your forms and controls in the .NET Framework project, and based on the file glob patterns we added to the .NET Core projects, any new or changed files will automatically be included in the .NET Core projects.
Once Visual Studio 2019 supports the Windows Forms Designer, you can copy/paste the content of your .NET Core project file into the .NET Framework project file. Then delete the file glob patterns added with the <Source>
and <EmbeddedResource>
items. Fix the paths to any project reference used by your app. This effectively upgrades the .NET Framework project to a .NET Core project.
Next steps
- Learn about breaking changes from .NET Framework to .NET Core.
- Read more about the Windows Compatibility Pack.
- Watch a video on porting your .NET Framework Windows Forms project to .NET Core.