Syncfusion® Licensing Overview

23 Jul 20263 minutes to read

Starting with the version 16.2.0.x release of Essential Studio®, Syncfusion® introduced a new licensing system. These modifications apply to all evaluators (trial users) and to paid customers who reference Syncfusion® assemblies through the nuget.org feed. Starting with v16.2.0.x, if you use the trial installer or the NuGet feed to reference Syncfusion® assemblies, you must also include the corresponding version license key in your projects.

The Syncfusion License Key is a unique string that must be registered in your application before initializing any Syncfusion controls. Registering the license key ensures that your application runs without licensing validation messages when using Syncfusion assemblies or NuGet packages.

NOTE

Don’t use the Unlock Key instead of the License Key in your application. The Unlock Key is used only for installing the Syncfusion offline installer. This key typically starts with @ and ends with =.

The following licensing error is displayed if the license key is not registered in your projects while using assemblies from the evaluation installer or from nuget.org.

This application was built using a trial version of Syncfusion Essential Studio. To remove the license validation message permanently, a valid license key must be included.

If you are using Documentation solutions libraries, the trial message is displayed as a watermark in the generated documents.

Example: Trial watermark rendered in a generated PDF document.

IO Licensing Message

Registering the license key in your application

The license key is a runtime string that must be registered before any Syncfusion® control is initialized. A minimal registration call is shown below.

Registering a single license key (C#)

Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR_LICENSE_KEY");

Starting with v31.1.17, if your application uses components from multiple editions (for example, the UI Edition and the PDF Viewer SDK), register each generated license key. Refer to How to Register the License Key in the Application for the complete set of platforms (ASP.NET Core, Blazor, JavaScript, Java, etc.) and placement guidance (startup, Main, appsettings.json, environment variable).

Registering Syncfusion® license keys in a build server

Source of Syncfusion® assemblies Details License key needs to be registered? Where to get the license key from
NuGet package If the Syncfusion® assemblies used in the build server are obtained from Syncfusion® NuGet packages, you do not need to install any Syncfusion® installer. Reference the required Syncfusion® NuGet packages directly from nuget.org. When using NuGet packages from nuget.org, register the Syncfusion® license key in the application. Yes Use any developer license to generate keys for build environments.
Trial installer If the Syncfusion® assemblies used in the build server are obtained from the trial installer, register the license key in the application for the corresponding version and platform to avoid the trial license warning. Yes Use any developer trial license to generate keys for build environments.
Licensed installer If the Syncfusion® assemblies used in the build server are obtained from the licensed installer, you do not need to register the license keys. You can download and install the licensed version of our installer. No Not applicable

See Also