Install Syncfusion WinForms NuGet packages

28 Oct 20215 minutes to read

Overview

NuGet is a Package management system for Visual Studio. It makes it easy to add, update and remove external libraries in our application. Syncfusion publishing all WinForms NuGet packages in nuget.org. The Syncfusion WinForms NuGet packages can be used without installing the Syncfusion Essential Studio setup. You can simply exploit the Syncfusion WinForms NuGet packages in WinForms application to develop with the Syncfusion WinForms components.

From v16.2.0.46 (2018 Volume 2 Service Pack 1) onwards, all the Syncfusion WinForms components are available as NuGet packages at nuget.org.

Installation using Package Manager UI

The NuGet Package Manager UI allows you to search, install, uninstall, and update Syncfusion WinForms NuGet packages in your applications and solutions. You can find and install the Syncfusion WinForms NuGet packages in your Visual Studio WinForms application and this process is easy with the steps below:

  1. Right-click on the WinForms application or solution in the Solution Explorer, and choose Manage NuGet Packages…

    Manage NuGet Packages add-in

    As an alternative, after opening the WinForms application in Visual Studio, go to the Tools menu and after hovering NuGet Package Manager, select Manage NuGet Packages for Solution…

  2. The Manage NuGet Packages window will open. Navigate to the Browse tab, then search for the Syncfusion WinForms NuGet packages using a term like “Syncfusion.WinForms” and select the appropriate Syncfusion WinForms NuGet package for your development.

    The nuget.org package source is selected by default in the Package source drop-down. If your Visual Studio does not have nuget.org configured, follow the instructions in the Microsoft documents to set up the nuget.org feed URL.

    WinForms NuGet Packages Search

  3. When you select a package, the right side panel will provide more information about it.

  4. By default, the package selected with latest version. You can choose the required version and click the Install button and accept the license terms. The package will be added to your WinForms application.

    WinForms NuGet Packages Install

  5. At this point, your application has all the required Syncfusion assemblies, and you will be ready to start building high-performance, responsive app with Syncfusion WinForms components. Also, you can refer to the Syncfusion WinForms help document for development.

Installation using Dotnet (.NET) CLI

The dotnet Command Line Interface (CLI), allows you to add, restore, pack, publish, and manage packages without making any changes to your application files. Dotnet add package adds a package reference to the application file, then runs dotnet restore to install the package.

Follow the below instructions to use the dotnet CLI command to install the Syncfusion WinForms NuGet packages.

  1. Open a command prompt and navigate to the directory where your Syncfusion WinForms project file is located.
  2. To install a NuGet package, run the following command.

    dotnet add package <Package name>

    For Example:
    dotnet add package Syncfusion.Grid.Windows

    If you don’t provide a version flag, this command will be upgrading to the latest version by default. To specify a version, add the -v parameter: dotnet add package Syncfusion.Grid.Windows -v 19.2.0.57

  3. Examine the Syncfusion WinForms project file after the command has completed to ensure that the Syncfusion WinForms package was installed. To see the added reference, open the .csproj file.

    Winforms Package Entry

  4. Then run dotnet restore command to restores all the packages listed in the application file.

    Restoring is done automatically with dotnet build and dotnet run in .NET Core 2.0 and later.

  5. At this point, your application has all the required Syncfusion assemblies, and you will be ready to start building high-performance, responsive app with Syncfusion WinForms components. Also, you can refer to the Syncfusion WinForms help document for development.

Installation using Package Manager Console

The Package Manager Console saves NuGet packages installation time since you don’t have to search for the Syncfusion WinForms NuGet package which you want to install, and you can just type the installation command to install the appropriate Syncfusion WinForms NuGet package. Follow the instructions below to use the Package Manager Console to reference the Syncfusion WinForms component as NuGet packages in your WinForms application.

  1. To show the Package Manager Console, open your WinForms web application in Visual Studio and navigate to Tools -> NuGet Package Manager -> Package Manager Console.

    Package Manager Console

  2. The Package Manager Console will be shown at the bottom of the screen. You can install the Syncfusion WinForms NuGet packages by enter the following NuGet installation commands.

    Install specified Syncfusion WinForms NuGet package.

    The below command will install the Syncfusion WinForms NuGet package in the default WinForms application.

    Install-Package <Package Name>

    For example: Install-Package Syncfusion.Grid.Windows

    You can find the list of Syncfusion WinForms NuGet packages which are published in nuget.org from here

    Install specified Syncfusion WinForms NuGet package in specified WinForms application

    The below command will install the Syncfusion WinForms NuGet package in the given WinForms application.

    Install-Package <Package Name> -ProjectName <Project Name>

    For example: Install-Package Syncfusion.Grid.Windows -ProjectName SyncfusionWinformsApp

  3. By default, the package will be installed with latest version. You can give the required version with the -Version term like below to install the Syncfusion WinForms NuGet packages in the appropriate version.

    Install-Package Syncfusion.Grid.Windows -Version 19.2.0.59

    Package Manager Console Output

  4. The NuGet package manager console will install the Syncfusion WinForms NuGet package as well as the dependencies it has. When the installation is complete, the console will show that your Syncfusion WinForms package has been successfully added to the application.

  5. At this point, your application has all the required Syncfusion assemblies, and you will be ready to start building high-performance, responsive app with Syncfusion WinForms components. Also, you can refer to the Syncfusion WinForms help document for development.