Create WinForms application

18 Dec 20234 minutes to read

Syncfusion provides the Visual Studio Project Template for the Syncfusion WinForms platform to create the Syncfusion WinForms Application by adding the required Syncfusion assemblies and forms.

IMPORTANT

The Syncfusion Windows Forms templates are available from v14.3.0.49.

WinForms Project Template works seamlessly with Visual Studio 2015 or lower. For the Visual Studio 2017 or later versions, it is recommended to use a WinForms Template Studio.

Use the following steps to create the Syncfusion Windows Forms project through the Visual Studio Project Template.

Check whether the WinForms Extensions - Syncfusion are installed or not in Visual Studio 2015 or lower by going to Tools -> Extensions and Updates -> Installed. If this extension not installed, please install the extension by follow the steps from the download and installation help topic.

1. To create a Syncfusion Windows Forms project, follow either one of the options below:

   Option 1:
   Click Syncfusion Menu and choose Essential Studio for WinForms > Create New Syncfusion Project… in Visual Studio.

   

   NOTE

   In Visual Studio 2015 or lower, you can see the Syncfusion menu directly in the Visual Studio menu.

   Option 2:
   Choose File -> New -> Project. Opens a new dialog to create a new project. You can obtain the templates provided by Syncfusion for WinForms by filtering the project type with Syncfusion or by using the Syncfusion keyword in the search option

   

   In Visual Studio 2015 or lower, Select File > New > Project and navigate to Syncfusion > Windows > Syncfusion Windows Forms Application in Visual Studio.

   

2. Name the Project, choose the destination location when required, select the project type, and choose the reference from where the assembly is added to the project then click OK.

   NOTE

   Minimum target Framework is 3.5 for Syncfusion WinForms project templates.

3. Choose the options to configure the Syncfusion WinForms Application by using the following Project Configuration Wizard.

   

   In Visual Studio 2015 or lower, Syncfusion Windows Forms Application project configuration wizard.

   

   Project Configurations

   Project Type: Select the project type, either .NET Framework or .NET Core.

   Language: Select the language, either CSharp or VB.

   Reference From: Choose the assembly location such as NuGet, GAC Location, or Essential Studio installed location, from where the assembly is added to the project.

   NOTE

   Installed location and GAC option will be available only when the Syncfusion Essential Windows Forms setup has been installed. You can use NuGet option without installing the Syncfusion Essential Windows Forms setup.

   Installed ES Build Version: Choose the build version to add the corresponding version assemblies to the project.

   NOTE

   Installed ES build version option will be available only when you install the Syncfusion Essential Windows Forms setup and choose the assembly location as Installed Location or GAC.

   Select Window: Choose the window as required for application.

4. After choosing above project configuration options in the Project Configuration Wizard, click the create button then Syncfusion WinForms project is created with the necessary XAML files and required Syncfusion WinForms assemblies/NuGet packages.

   

   

   

5. Then, the Syncfusion licensing registration required message box will be shown, if you installed the trial setup or NuGet packages since Syncfusion introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the help topic, which is shown in the licensing message box to generate and register the Syncfusion license key to your project. Refer to this blog post to learn more the licensing changes introduced in Essential Studio.