Syncfusion Blazor License

Syncfusion Blazor License Configuration

Manage Syncfusion Blazor license keys across all Blazor project types - Server, WebAssembly, Auto, and Razor Class Libraries.

When to Use

Use this skill when you need to:

• Generate a Syncfusion license key (paid, trial, or temporary)
• Register a license key in any Blazor project type
• Secure license keys in Blazor WebAssembly projects (avoid browser exposure)
• Validate licenses in CI/CD pipelines (Azure Pipelines, GitHub Actions, Jenkins)
• Troubleshoot license errors — trial banner, invalid key, platform or version mismatch

Do NOT use for:

• Initial Blazor project setup → use syncfusion-blazor-common

Key Rules

• Version Specific: License keys are version-specific for the Syncfusion platform
• Platform Specific: Different keys for different platforms (Blazor, ASP.NET, etc.)
• WASM Security: Never register license keys in client-side Blazor WebAssembly Program.cs — use licensed NuGet packages instead
• Confidentiality: License keys are secrets. Never share or commit them to source

Common Scenarios

Generate a license key

• Reference: Generating License Keys

Register a license key

• Reference: Registering License Keys

Razor Class Library with Syncfusion Blazor components

• Reference: Registering in RCLs

Blazor WebAssembly app (security concern)

Security Warning (WASM): Do NOT register license keys in client-side Blazor WebAssembly Program.cs or commit keys into source. Client-side assemblies are downloadable and can expose license keys to end users. Treat license keys like secrets.

⚠️ Do NOT register keys in client-side code. See secure deployment options:

• Reference: Secure Registration in WASM Apps

Recommended: Use licensed NuGet packages instead

• Reference: Web Installer - How to Download
• Reference: Web Installer - How to Install

Troubleshooting license errors

• Reference: Troubleshooting Licensing Errors

FAQ

• Licensing FAQ

Syncfusion Blazor License Generation & Registration Guide

Applies to: Syncfusion Blazor Components

Framework: .NET 8, .NET 9, .NET 10 with Blazor Web App

Reference: Official Syncfusion Documentation

Purpose: Complete reference guide for generating, registering, and managing Syncfusion Blazor license keys across different project types and deployment scenarios.

---

Quick Reference Navigation

1. Generating License Keys 2. Registering License Keys in Applications 3. Registering When Consuming a Razor Class Library (RCL) 4. Secure Registration in Blazor WASM Apps 5. Troubleshooting Licensing Errors 6. Licensing FAQ

---

Generating License Keys

License Portal Locations

Generate license keys from the Syncfusion account portals:

1. Licensed Products: License & Downloads Portal 2. Trial/Evaluation: Trial & Downloads Portal

License Generation States

Depending on your account status, different keys are generated:

Active License

• Generated from Claim License Key page
• Valid license associated with account
• Full version key without expiration

Active Trial

• Trial period key with expiration date
• Valid for 30-day evaluation period
• Generated on demand from Trial & Downloads portal

Expired License

• Temporary 5-day validity key generated automatically
• Renew subscription for latest version
• Upgrade to full license recommended

No Trial or No License

• Request trial or purchase license from Claim License Key page
• Create Syncfusion account if needed
• Options: Free trial or purchase

Important Notes on License Keys

• Version Specific: License keys are version-specific for the Syncfusion platform
• Platform Specific: Different keys for different platforms (Blazor, ASP.NET, etc.)
• Know Your Version: Check Which version license key should I use?
• Key Generation Details: See How to generate license key for licensed products

---

Registering License Keys in Applications

Registration Basics

Important Requirements:

• Register license key BEFORE any Syncfusion Blazor component is initialized
• Place license key in double quotes
• Ensure Syncfusion.Licensing.dll is referenced in the project
• Register during application startup
• License validation is offline - no internet required for running

Registration Code Template

Security Warning (WASM): Do NOT register license keys in client-side Blazor WebAssembly Program.cs or commit keys into source. Client-side assemblies are downloadable and can expose license keys to end users. Treat license keys like secrets.

using Syncfusion.Licensing;

// Register the Syncfusion license
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");

Registration by Project Type

1. Blazor Web App (Interactive Auto)

Location: Register in BOTH server and client projects

Security Warning (WASM): Do NOT register license keys in client-side Blazor WebAssembly Program.cs or commit keys into source. Client-side assemblies are downloadable and can expose license keys to end users. Treat license keys like secrets.

Server/Program.cs:

// Register the Syncfusion license
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");

Client/Program.cs:

// Register the Syncfusion license
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");

2. Blazor Web App (Interactive Server)

Location: Server project only

Server/Program.cs (.NET 8, 9, 10):

var app = builder.Build();
// Register the Syncfusion license
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Home/Error");
    app.UseHsts();
}

3. Blazor Web App (Interactive WebAssembly)

Security Warning (WASM): Do NOT register license keys in client-side Blazor WebAssembly Program.cs or commit keys into source. Client-side assemblies are downloadable and can expose license keys to end users. Treat license keys like secrets.

Location: Register in BOTH server and client projects

Server/Program.cs:

// Register the Syncfusion license
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");

Client/Program.cs:

// Register the Syncfusion license
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");

4. Blazor Standalone WebAssembly App

Security Warning (WASM): Do NOT register license keys in client-side Blazor WebAssembly Program.cs or commit keys into source. Client-side assemblies are downloadable and can expose license keys to end users. Treat license keys like secrets.

Location: Client project only

Program.cs:

// Register the Syncfusion license
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");

var builder = WebAssemblyHostBuilder.CreateDefault(args);
// ... rest of configuration

Registration Location Reference Table

---

Registering When Consuming a Razor Class Library (RCL)

RCL Registration Strategy

When your application references a Razor Class Library (RCL) that uses Syncfusion components, register the license key in the consuming application's Program.cs — not in the RCL project itself.

Requirement: License key must be registered BEFORE any Syncfusion component is initialized

By Hosting Model

In Blazor Web App (referencing RCL)

Program.cs:

// Register the Syncfusion license
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");

In Blazor Server App (referencing RCL)

Program.cs (.NET 8, 9, 10):

var app = builder.Build();
// Register the Syncfusion license
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Home/Error");
    app.UseHsts();
}

In Blazor WebAssembly App (referencing RCL)

Program.cs:

// Register the Syncfusion license
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");

---

Secure Registration in Blazor WASM Apps

Security Warning (WASM): Do NOT register license keys in client-side Blazor WebAssembly Program.cs or commit keys into source. Client-side assemblies are downloadable and can expose license keys to end users. Treat license keys like secrets.

Security Concerns

Warning: Registering license key directly in Program.cs of Blazor WebAssembly client project exposes it through compiled assemblies, making it accessible in the browser.

Recommended Solution: Licensed NuGet Packages

BEST PRACTICE: Use licensed NuGet packages from the web installer instead of registering keys in code.

Benefits of Licensed Packages

• Enhanced security - prevents license key exposure in browser
• Simplified deployment - no manual registration needed
• No browser-accessible security risks

Implementation: Licensed NuGet Packages

Step 1: Download Licensed Packages

• Web Installer How to Download
• Web Installer How to Install

Step 2: Configure Package Source Mapping

Use NuGet.config to ensure licensed packages only:

NuGet.config:

<configuration>
  <packageSources>
    <add key="licensed-nuget" value="path/to/your/nuget-source" />
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
  </packageSources>
  <packageSourceMapping>
    <packageSource key="licensed-nuget">
      <package pattern="Syncfusion.*" />
    </packageSource>
  </packageSourceMapping>
</configuration>

Step 3: Verify Assembly Licensing

Check if you're using licensed or trial assemblies:

1. Navigate to build output directory 2. Right-click Syncfusion assembly → Properties → Details tab 3. Check File Description:

• Contains "LR" = Trial version (requires registration)
• Does NOT contain "LR" = Licensed version (no registration needed)

Step 4: Clean Build if Trial Detected

If trial assemblies found:

# Clear NuGet cache
dotnet nuget locals all --clear

# Delete bin and obj folders
# Uninstall and reinstall packages from licensed source only

Package Source Options

• Local Folder: Store packages locally
• Private Repository Manager: Use Nexus or Azure DevOps Artifacts

Warning: When using both local/private and nuget.org, restore may default to nuget.org trial versions, causing license issues.

Alternative: Azure Key Vault Integration

For enhanced security in cloud environments, store license keys in Azure Key Vault:

• Retrieve at runtime
• Never exposed in browser or client-side code

---

Troubleshooting Licensing Errors

Error: License Key Not Registered or Trial Expired

Message: "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."

Solutions:

1. If you have a valid Syncfusion license:

• Generate key from License & Downloads
• Register in application

2. If you have active trial:

• Generate key from Trial & Downloads
• Register in application

3. If no active trial:

• Purchase license OR
• Start free 30-day trial
• Then generate and register key

4. If no Syncfusion account:

• Create account
• Purchase license OR start trial
• Generate and register key

5. Quick option in warning dialog:

• Click "Claim your FREE account" in warning message
• See How to Generate License Key

Error: Invalid Key

Message: "The included Syncfusion® license key is invalid."

Causes:

• Invalid/incorrect license key
• Different version license key than installed packages
• Different platform license key than application type
• Mismatched assembly versions

Solutions: 1. Verify key matches your Syncfusion version 2. Verify key platform matches (Blazor, not ASP.NET Core, etc.) 3. Ensure all Syncfusion packages are same version 4. Ensure Syncfusion.Licensing version matches other packages 5. Register key before any component initialization

Error: Platform Mismatch

Message: "The included Syncfusion® license is invalid (Platform mismatch)."

Cause: License key is for different platform (e.g., ASP.NET Core key in Blazor app)

Solution:

• Generate correct platform-specific key
• Register correct key for Blazor platform

Error: Version Mismatch

Message: "The included Syncfusion® license ({Registered Version}) is invalid for version {Required version}."

Cause: License key version doesn't match installed package version

Solution: 1. Identify installed package version 2. Generate license key for matching version 3. Ensure all packages same version 4. Clean bin/obj and rebuild

Troubleshooting License Errors (General)

If error persists after proper registration:

1. Verify Syncfusion.Licensing NuGet package version matches other packages 2. Check all Syncfusion assemblies are same version 3. Confirm license key registered before component initialization 4. Verify same version assemblies in output and publish folders 5. After package upgrade:

• Clean bin/obj folders
• Clear NuGet cache: dotnet nuget locals all --clear
• Rebuild solution

6. Check referenced assemblies match license key

---

Licensing FAQ

Is Internet Connection Required?

No.

• License validation is offline during application execution
• No internet access required to run licensed apps
• Can deploy on systems without internet connection
• Validation happens locally on the machine

How Do I Upgrade from Trial to Paid License?

Option 1: Replace Assemblies

• Uninstall trial version
• Install licensed build from License & Downloads portal
• No code changes needed

Option 2: Replace License Key (NuGet users) 1. Generate paid license key from License & Downloads 2. Replace trial key with paid key in application code 3. See Registration Guide

Note: License registration not required if using licensed installer (volume/service pack).

Where Can I Get a License Key?

Generate from Syncfusion account portals:

• License & Downloads Portal - For licenses
• Trial & Downloads Portal - For trials

Important:

• Keys are version-specific - verify correct version
• Keys are platform-specific - verify correct platform
• See Which version should I use?

How Do I Register a Syncfusion Account for NuGet.org Users?

If using packages directly from NuGet.org without account:

1. Create Syncfusion account 2. Go to Start Trials and start trial 3. Go to Trial & Downloads 4. Generate trial license key 5. Register in application

Downloading the Syncfusion Blazor Web Installer

This document explains how to download the Syncfusion Blazor Web Installer for both trial and licensed users. The same installer is used in all cases; available features depend on the account you sign in with.

---

Overview

The Syncfusion Blazor Web Installer is a unified setup package. After downloading, you unlock it by signing in with your Syncfusion account, and the installer enables either trial or licensed components based on your account status.

---

Trial Version (30-Day Evaluation)

You can download a 30-day trial installer using one of the following methods.

Option 1: Download Free Trial Setup

1. Visit the Download Free Trial page on the Syncfusion website. 2. Select Blazor as the platform. 3. Sign in or complete the registration form. 4. Download the Blazor trial installer from the confirmation page. 5. Run the installer and sign in with your Syncfusion credentials to unlock it.

You can re-download the installer anytime during the trial period from the Trials & Downloads section of your Syncfusion account.

---

Option 2: Start Trial (NuGet Users)

If you are already using Syncfusion components through NuGet.org:

1. Go to the Start Trials page. 2. Sign in or register for a Syncfusion account. 3. Start a 30-day evaluation for Blazor. 4. Navigate to Trials & Downloads and download the installer.

Note: If an active Blazor trial already exists, you cannot start another trial for the same product.

Before the trial expires, make sure to generate:

• Installer unlock key
• Project license key

---

Licensed Version

For users with an active or expired license:

1. Sign in to your Syncfusion account. 2. Open License & Downloads. 3. Locate your Blazor license. 4. Click Download to get the Blazor web installer. 5. Run the installer and sign in with your registered Syncfusion credentials.

You can download the installer at any time while your license is valid.

---

Important Notes

• There is no separate installer for trial and licensed users.
• The same web installer is used in all cases.
• Product access is determined after signing in with your Syncfusion account.

---

Next Steps

After downloading the installer, follow the [Web Installer - How to Install](./syncfusion-blazor-web-installer-install.md) guide in the Syncfusion Blazor documentation to complete the setup.

Installing the Syncfusion Blazor Web Installer

This document describes how to install, configure, and uninstall Syncfusion Blazor components using the Syncfusion Blazor Web Installer. The installer supports both trial and licensed accounts, with product access determined after sign-in.

---

Installation Prerequisites

• Download the Syncfusion Blazor Web Installer (.exe) from your Syncfusion account.
• Ensure you have internet access for authentication and package downloads.
• Sign in with a valid Syncfusion account (trial or licensed).

---

Install Syncfusion Blazor

Step 1: Launch the Installer

1. Locate the downloaded Blazor web installer executable. 2. Double-click the file to start the installer. 3. The installer extracts the required setup files and opens the welcome wizard. 4. Click Next to continue.

---

Step 2: Select Products

1. The Platform Selection screen appears. 2. In the Available tab, select the Blazor products you want to install. 3. To install everything, choose Install All. 4. If products from the same version are already installed, they appear under the Installed tab, where you can also choose products to uninstall. 5. Click Next.

Note: If any required third-party software is missing, the installer shows a warning. You may proceed and install the prerequisites later.

---

Step 3: Handle Previous Versions

1. If earlier versions of selected products are detected, the installer prompts you to remove them. 2. Review the list of older versions. 3. Choose Uninstall All to remove previous versions, or modify the selection as needed. 4. Confirm when prompted and click Next.

---

Step 4: Review and Configure

1. The Confirmation screen summarizes products to be installed or removed. 2. Review the list carefully. 3. Use Download Size and Installation Size links to view approximate disk usage. 4. Click Next.

---

Step 5: Configuration Settings

You can customize installation settings on this screen:

• Download Location - where setup packages are stored
• Install Location - where Syncfusion components are installed
• Demos Location - where sample projects are placed

Additional Options

• Install demos (Syncfusion samples)
• Configure Syncfusion extensions in Visual Studio
• Create a desktop shortcut for the Syncfusion Control Panel
• Create a Start Menu shortcut for the Syncfusion Control Panel

Select I agree to the License Terms and Privacy Policy, then click Next.

---

Step 6: Sign In and Install

1. Enter your Syncfusion account email and password. 2. Use Create an account or Forgot password if needed. 3. Click Install.

Important: Products are installed based on your Syncfusion license (trial or licensed).

The installer shows download, installation, and uninstallation progress.

---

Step 7: Complete Installation

1. When installation finishes, the Summary screen appears. 2. Review which products were installed successfully and which failed. 3. Click Finish to exit the installer. 4. Optionally select Launch Control Panel to manage installed products.

After installation, two Control Panel entries may be visible:

• Essential Studio - manages all Syncfusion products for the same version
• Product-specific entry - manages only Blazor products

---

Uninstall Syncfusion Blazor

Syncfusion Blazor components can be removed in two ways.

---

Option 1: Uninstall Using the Web Installer

1. Open the Syncfusion Blazor Web Installer executable. 2. Go to the Installed tab. 3. Select the products to uninstall, or choose Uninstall All. 4. Follow the wizard steps to complete uninstallation.

---

Option 2: Uninstall from Windows Control Panel

1. Open Windows Control Panel → Programs and Features. 2. Choose one of the following:

• Syncfusion Essential Studio {version} - removes all Syncfusion products of that version
• Syncfusion Essential Studio for Blazor {version} - removes only Blazor components

3. Follow the on-screen uninstallation steps.

---