Item Template Extension

11 Feb 20224 minutes to read

The Syncfusion Item Templates extensions provides support to add a predefined form for the Windows Forms applications.

IMPORTANT

The Syncfusion Windows Forms item templates are available from v13.1.0.21.

Follow the given steps to add the Syncfusion item in Visual Studio.

Before use the Syncfusion WinForms Item 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.If this extension not installed, please install the extension by follow the steps from the download and installation help topic.

  1. Open a new or existing WinForms application.

  2. Right-click the WinForms Project from the Solution Explorer. Select the Add Syncfusion Item New Item… option.

    Syncfusion Item Template add-in

  3. Now, the Syncfusion Item Template Gallery window will be open.

    Syncfusion Item Template wizard

  4. Select the required assembly location, version, and Form from the Syncfusion Item Template Gallery.

    Select the Form from the Syncfusion Item Template Wizard

    Assembly From: Choose an assembly reference option such as GAC location, Essential Studio installed location, or NuGet packages, to specify where from the required Syncfusion assemblies are added to the project.

    Select the required assembly location from the Syncfusion Item Template Wizard

    NOTE

    Installed location and GAC option will be available only when the Syncfusion Essential WinForms setup has been installed. You can use NuGet option without installing the Syncfusion Essential Windows Forms setup. If you add the Syncfusion item files in .NET Core Windows Forms application, GAC option will not be listed in the Assembly From option.

    Version: Choose the Essential Studio version to add the corresponding version assemblies to the project.

    Select the required ES version from the Syncfusion Item Template Wizard

    NOTE

    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.

    Template Gallery: This part contains a set of Syncfusion Item Templates, and you can choose the Item Templates as required. When the Add button is clicked, the selected item template is added to the project.

    Selected Item Template

  5. Then, 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 for understanding the licensing changes introduced in Essential Studio.

    Syncfusion license registration required information dialog in Syncfusion Item Template

Using Visual Studio Add new Item

Syncfusion Project Template can also be added from the Visual Studio Item Template.

  1. To create a Syncfusion WinForms item template, follow either one of the options below:

    Option 1
    Click Syncfusion Menu and choose Essential Studio for WinForms > Add Office2010Form… or any other Form in Visual Studio.

    Syncfusion Project Template can be also add from the Visual Studio Item Template via Syncfusion Menu

    NOTE

    From Visual Studio 2019, Syncfusion menu is available under Extensions in Visual Studio menu.

    Option 2
    Right-click the Windows Forms Project, select Add > New Item, and then navigate to Visual C# Items or VB Items > Syncfusion > Windows. Refer to the following screenshot for more information.

    Syncfusion Project Template can be also add from the Visual Studio Item Template

  2. The Syncfusion Item Templates are available under the Syncfusion tab. It is available for both C# Items and VB Items.

    Select required Item Template from Visual Studio Item Template Wizard

  3. Now the selected template is added to the project along with Syncfusion references.

    Selected Syncfusion Item Template added to the project with Forms

    Selected Syncfusion Item Template required reference assemblies

  4. Then, 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 for understanding the licensing changes introduced in Essential Studio.

    Syncfusion license registration required information dialog in Windows Forms project