Create WinForms application

28 Jun 20214 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.

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

Before use the Syncfusion WinForms Project Template, check whether the WinForms Extensions - Syncfusion installed or not in Visual Studio Extension Manager by clicking on the Tools -> Extensions and Updates -> Installed for Visual Studio 2017 or lower and for Visual Studio 2019 by clicking on the Extensions -> Manage Extensions -> Installed.

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

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

    Choose Syncfusion Windows Forms Application via Syncfusion menu

    NOTE

    In Visual Studio 2017 or lower, the Syncfusion menu is available 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

    Choose Syncfusion Windows Forms Application from Visual Studio new project dialog

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

    Choose Syncfusion Windows Forms Application from Visual Studio new project dialog

  2. Name the Project, choose the destination location when required, and set the .NET Framework of 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.

    Syncfusion Windows Forms project configuration wizard

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

    Syncfusion Windows Forms project configuration wizard

    Project Configurations

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

    NOTE

    Project type selection option will be available only in Visual Studio 2019 Syncfusion Windows Forms Project template configuration. The .NET Core 3.1 and .NET 5.0 option will be listed in project type only when the .NET Core 3.1 and .NET 5.0 setup has been installed.

    Language: Select the language, either CSharp or VB.

    Reference From: Choose the assembly location from where it is going to be 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. Also, the GAC option will not be available when you choose .NET 5.0 and .NET Core 3.1 from project type option in Visual Studio 2019.

    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 the Project Configuration Wizard is done, the Syncfusion WinForms project is created with required references and forms.

    Syncfusion Windows Forms project created with required references

    Syncfusion Windows Forms project created with required forms

    Syncfusion Windows Forms project created with readme

  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.

    Syncfusion license registration required information dialog in Syncfusion Windows Forms Project