Skip to content

Commit 227a1c9

Browse files
committed
Updated the Blazor common UG documentation
1 parent 19a40fd commit 227a1c9

File tree

5 files changed

+98
-98
lines changed

5 files changed

+98
-98
lines changed
Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,47 @@
11
---
22
layout: post
3-
title: Overview of Syncfusion license generation - Syncfusion
4-
description: Learn here about how to generate Syncfusion blazor license key for syncfusion blazor application for license validation.
3+
title: Generate Blazor license key | Syncfusion
4+
description: Learn here all about how to generate a Syncfusion Blazor license key for evaluation or licensed usage, including platform- and version-specific guidance.
55
platform: Blazor
6-
component: Common
6+
control: Common
77
documentation: ug
88
---
99

10-
# Generate Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor License Key
10+
# Generate Syncfusion® Blazor License Key
1111

12-
License keys can be generated from the [License & Downloads](https://syncfusion.com/account/downloads) or [Trial & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) section of the Syncfusion<sup style="font-size:70%">&reg;</sup> website.
12+
Generate license keys from the [License & Downloads](https://syncfusion.com/account/downloads) portal or the [Trial & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) page of the Syncfusion<sup style="font-size:70%">&reg;</sup> website.
1313

14-
![Get Community License Key](images/get-community-license-key.png)
14+
![License & Downloads portal showing the Get Community License Key option](images/get-community-license-key.png)
1515

16-
N> * Syncfusion<sup style="font-size:70%">&reg;</sup> license keys are **version and platform specific**. Refer to the [KB](https://www.syncfusion.com/kb/8976/how-to-generate-license-key-for-licensed-products) to generate the license key for the required version and platform.
17-
* Refer to this [KB](https://www.syncfusion.com/kb/8951/which-version-syncfusion-license-key-should-i-use-in-my-application) to know which version of the Syncfusion<sup style="font-size:70%">&reg;</sup> license key should be used in the application.
16+
N> * Syncfusion<sup style="font-size:70%">&reg;</sup> license keys are **version and platform specific**. See How to generate a license key for [licensed products](https://www.syncfusion.com/kb/8976/how-to-generate-license-key-for-licensed-products).
17+
* To determine which license key version to use in an application, see [Which version Syncfusion<sup style="font-size:70%">&reg;</sup> license key should I use in my application?](https://www.syncfusion.com/kb/8951/which-version-syncfusion-license-key-should-i-use-in-my-application).
1818

1919
## Claim License key
2020

21-
Syncfusion<sup style="font-size:70%">&reg;</sup> License keys can also be generated from the **"Claim License Key"** page based on the trial or valid license associated with your Syncfusion<sup style="font-size:70%">&reg;</sup> account.
21+
License keys can also be generated from the **Claim License Key** page based on the trial or active license associated with the Syncfusion<sup style="font-size:70%">&reg;</sup> account.
2222

23-
You can get the license key, based on license availability in your Syncfusion<sup style="font-size:70%">&reg;</sup> account.
23+
The generated key depends on license availability in the associated Syncfusion<sup style="font-size:70%">&reg;</sup> account.
2424

2525
### Active License
2626

27-
If you have a Syncfusion<sup style="font-size:70%">&reg;</sup> account associated with valid license, license key will be generated from claim license key page.
27+
If the account has a valid license, a license key is generated from the Claim License Key page.
2828

29-
![Active License](images/active-license.png)
29+
![Claim License Key page showing an active license state](images/active-license.png)
3030

3131
### Active Trial
3232

33-
If you have a Syncfusion<sup style="font-size:70%">&reg;</sup> account associated with valid trial license, license key will be generated from claim license key page with expiry date.
33+
If the account has a valid trial license, a license key is generated with an expiry date.
3434

35-
![Active Trial](images/active-trial.png)
35+
![Claim License Key page showing an active trial state with expiry date](images/active-trial.png)
3636

3737
### Expired License
3838

39-
If you have a Syncfusion<sup style="font-size:70%">&reg;</sup> account with an expired license, your license subscription must be renewed in order to obtain a valid license key for the latest Essential Studio<sup style="font-size:70%">&reg;</sup> version. Meanwhile, a temporary license key with a 5-day validity period will be generated.
39+
If the account license has expired, renew the subscription to obtain a valid license key for the latest Essential Studio<sup style="font-size:70%">&reg;</sup> version. A temporary license key with a 5day validity period is generated in the meantime.
4040

41-
![Expired License](images/expired-license.png)
41+
![Claim License Key page indicating an expired license with temporary key notice](images/expired-license.png)
4242

4343
### No Trial or No License or Expired trial
4444

45-
If the Syncfusion<sup style="font-size:70%">&reg;</sup> account is not associated with a trial, license, or expired trial, you can try to claim either a trial or a valid license from claim license page.
45+
If the account does not have an active trial or license, request a trial or obtain a valid license from the Claim License Key page.
4646

47-
![No Trial or No License](images/no-active-trial-or-license.png)
47+
![Claim License Key page showing no active trial or license state](images/no-active-trial-or-license.png)

blazor/getting-started/license-key/how-to-register-in-a-razor-class-library.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
layout: post
3-
title: Overview of license key registration in Blazor | Syncfusion
4-
description: Learn here about how to register Syncfusion blazor license key for syncfusion Blazor application with license validation.
3+
title: Register a Blazor license key in a Razor Class Library | Syncfusion
4+
description: Learn how to register a Syncfusion Blazor license key in a Razor Class Library when using NuGet packages or evaluation builds. Explore to more details.
55
platform: Blazor
6-
component: Common
6+
control: Common
77
documentation: ug
88
---
99

10-
# Register Syncfusion<sup style="font-size:70%">&reg;</sup> License Key in a Razor Class Library Application
10+
# Register a Syncfusion® license key in a Razor Class Library App
1111

12-
The generated license key is just a string that might be registered before any Syncfusion<sup style="font-size:70%">&reg;</sup> control is initiated. The following code is used to register the license.
12+
Register the Syncfusion<sup style="font-size:70%">&reg;</sup> license key before any Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor component is initialized. Place the key in the Razor Class Library (RCL) project so every consuming app inherits the registration.
1313

1414
{% tabs %}
1515
{% highlight c# %}
@@ -22,19 +22,19 @@ Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY
2222
N> * Place the license key between double quotes. Also, ensure that Syncfusion.Licensing.dll is referenced in your project where the license key is being registered.
2323
* Syncfusion<sup style="font-size:70%">&reg;</sup> license validation is done offline during application execution and does not require internet access. Apps registered with a Syncfusion<sup style="font-size:70%">&reg;</sup> license key can be deployed on any system that does not have an internet connection.
2424

25-
If your Razor Class Library (RCL) project uses Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor packages from [nuget.org](https://www.nuget.org/packages?q=syncfusion) or the trial installer, you must register your license key. We need to register the license key in RCL project similar to how we do for the Blazor project based on your application type (Server application / Client WebAssembly application).
25+
If the RCL references Syncfusion Blazor packages from [nuget.org](https://www.nuget.org/packages?q=syncfusion) or from the trail installer, register the license key in the RCL before packaging or referencing it. The registration pattern mirrors the approach used in Blazor Apps (server or WebAssembly).
2626

27-
Refer to this [link](https://blazor.syncfusion.com/documentation/getting-started/razor-class-library) for more information on getting started with the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components in the RCL project.
27+
For setup guidance, see [Getting started](https://blazor.syncfusion.com/documentation/getting-started/razor-class-library) with Syncfusion Blazor in a Razor Class Library.
2828

2929
## Blazor Web App
3030

3131
Open **~/Program.cs** file and register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor license key in the Blazor web app.
3232

3333
{% tabs %}
3434

35-
{% highlight C# tabtitle="Blazor Web App" hl_lines="1 2" %}
35+
{% highlight c# tabtitle="Blazor Web App" hl_lines="1 2" %}
3636

37-
//Register Syncfusion license
37+
// Register the Syncfusion license
3838
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
3939

4040
{% endhighlight %}
@@ -43,16 +43,16 @@ Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY
4343

4444
## Blazor Server App
4545

46-
After configuring the RCL project with your Blazor Server application, register the license key in the Program.cs file.
46+
After referencing the RCL from a Blazor Server application, register the license key in Program.cs.
4747

48-
* For .NET 8 and .NET 9 app, open the **~/Program.cs** file and register the Syncfusion<sup style="font-size:70%">&reg;</sup> license key.
48+
* For .NET 8 and .NET 9 apps, open **~/Program.cs** and register the Syncfusion license key.
4949

5050
{% tabs %}
5151

52-
{% highlight C# tabtitle=".NET 8 & .NET 9 (~/Program.cs)" hl_lines="2 3" %}
52+
{% highlight c# tabtitle=".NET 8 & .NET 9 (~/Program.cs)" hl_lines="2 3" %}
5353

5454
var app = builder.Build();
55-
//Register Syncfusion license
55+
// Register the Syncfusion license
5656
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
5757

5858
// Configure the HTTP request pipeline.
@@ -69,14 +69,14 @@ if (!app.Environment.IsDevelopment())
6969

7070
## Blazor WebAssembly App
7171

72-
After configuring the RCL project with your Blazor Client WebAssembly application, register the license key in the Program.cs file.
72+
After referencing the RCL from a Blazor WebAssembly application, register the license key in Program.cs.
7373

7474
{% tabs %}
7575

76-
{% highlight c# tabtitle="~/Program.cs" hl_lines="3 4" %}
76+
{% highlight c# tabtitle="~/Program.cs" hl_lines="1 2" %}
7777

78-
// Register Syncfusion license
79-
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
78+
// Register the Syncfusion license
79+
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
8080

8181
{% endhighlight %}
8282

blazor/getting-started/license-key/how-to-register-in-an-application.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
layout: post
3-
title: Getting started with Blazor license key registration | Syncfusion
4-
description: Learn here about how to register Syncfusion blazor license key for blazor application for license validation.
3+
title: Register a Syncfusion Blazor license key | Syncfusion
4+
description: Learn here about how to register a Syncfusion Blazor license key in your application when using NuGet packages or evaluation builds. Explore to more details.
55
platform: Blazor
6-
component: Common
6+
control: Common
77
documentation: ug
88
---
99

10-
# Register Syncfusion<sup style="font-size:70%">&reg;</sup> License key in Blazor Application
10+
# Register a Syncfusion® license key in a Blazor application
1111

12-
Syncfusion<sup style="font-size:70%">&reg;</sup> license key should be registered, if your project using Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor packages reference from [nuget.org](https://www.nuget.org/packages?q=syncfusion) or from trial installer. The generated license key is just a string that needs to be registered before any Syncfusion<sup style="font-size:70%">&reg;</sup> control is initiated. The following code is used to register the license.
12+
Register the Syncfusion<sup style="font-size:70%">&reg;</sup> license key before any Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor component is initialized when referencing packages from [NuGet.org](https://www.nuget.org/packages?q=syncfusion) or using the trail installer. The license key is a string that must be registered at application startup.
1313

1414
{% tabs %}
1515
{% highlight c# %}
@@ -20,25 +20,27 @@ Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY
2020
{% endtabs %}
2121

2222
N> * Place the license key between double quotes. Also, ensure that Syncfusion.Licensing.dll is referenced in your project where the license key is being registered.
23-
* Syncfusion<sup style="font-size:70%">&reg;</sup> license validation is done offline during application execution and does not require internet access. Apps registered with a Syncfusion<sup style="font-size:70%">&reg;</sup> license key can be deployed on any system that does not have an internet connection.
23+
* Syncfusion<sup style="font-size:70%">&reg;</sup> license validation is done offline during application execution and does not require internet access. Apps registered with a Syncfusion<sup style="font-size:70%">&reg;</sup> license key can be deployed on any system that does not have an internet connection.
2424

2525
I> Syncfusion<sup style="font-size:70%">&reg;</sup> license keys can be validated during the Continuous Integration (CI) processes to ensure proper licensing and prevent licensing errors during deployment. Refer to the [CI License Validation](https://blazor.syncfusion.com/documentation/getting-started/license-key/ci-license-validation) section for detailed instructions on how to implement it.
2626

27-
| Blazor Mode | Project(s) to Register License Key | File(s) to Register License Key |
28-
|---------------------------------------|-----------------------------------------|-----------------------------------------|
29-
| Blazor Web App (Interactive Auto) | Server & Client | `Server/Program.cs`, `Client/Program.cs`|
30-
| Blazor Web App (Interactive Server) | Server | `Server/Program.cs` |
31-
| Blazor Web App (Interactive WASM) | Server & Client | `Server/Program.cs`, `Client/Program.cs`|
32-
| Blazor Standalone WebAssembly App | Client | `Program.cs` |
27+
Use the following table to determine where to register the license key based on the Blazor hosting model.
28+
29+
| Blazor mode | Projects to register the license key | Files to register the license key |
30+
|--------------------------------------|------------------------------------------|------------------------------------------|
31+
| Blazor Web App (Interactive Auto) | Server and client | `Server/Program.cs`, `Client/Program.cs` |
32+
| Blazor Web App (Interactive Server) | Server | `Server/Program.cs` |
33+
| Blazor Web App (Interactive WASM) | Server and client | `Server/Program.cs`, `Client/Program.cs` |
34+
| Blazor Standalone WebAssembly app | Client | `Program.cs` |
3335

3436
## Blazor Web App (Interactive Auto)
3537

3638
Open **~/Program.cs** file in both the server and client projects of a Blazor Web App(Interactive Auto) and register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor license key.
3739
{% tabs %}
3840

39-
{% highlight C# tabtitle="Blazor Web App" hl_lines="1 2" %}
41+
{% highlight c# tabtitle="Blazor Web App" hl_lines="1 2" %}
4042

41-
//Register Syncfusion license
43+
// Register the Syncfusion license
4244
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
4345

4446
{% endhighlight %}
@@ -51,10 +53,10 @@ Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY
5153

5254
{% tabs %}
5355

54-
{% highlight C# tabtitle=".NET 8 & .NET 9 (~/Program.cs)" hl_lines="2 3" %}
56+
{% highlight c# tabtitle=".NET 8 & .NET 9 (~/Program.cs)" hl_lines="2 3" %}
5557

5658
var app = builder.Build();
57-
//Register Syncfusion license
59+
// Register the Syncfusion license
5860
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
5961

6062
// Configure the HTTP request pipeline.
@@ -74,9 +76,9 @@ if (!app.Environment.IsDevelopment())
7476
Open **~/Program.cs** file in both the server and client projects of a Blazor Web App(Interactive WebAssembly) and register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor license key.
7577
{% tabs %}
7678

77-
{% highlight C# tabtitle="Blazor Web App" hl_lines="1 2" %}
79+
{% highlight c# tabtitle="Blazor Web App" hl_lines="1 2" %}
7880

79-
//Register Syncfusion license
81+
// Register the Syncfusion license
8082
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
8183

8284
{% endhighlight %}
@@ -89,9 +91,9 @@ Open **~/Program.cs** file and register the Syncfusion<sup style="font-size:70%"
8991

9092
{% tabs %}
9193

92-
{% highlight C# tabtitle=".NET 8 & .NET 9 (~/Program.cs)" hl_lines="1 2" %}
94+
{% highlight c# tabtitle=".NET 8 & .NET 9 (~/Program.cs)" hl_lines="1 2" %}
9395

94-
//Register Syncfusion license
96+
// Register the Syncfusion license
9597
Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
9698

9799
var builder = WebAssemblyHostBuilder.CreateDefault(args);

0 commit comments

Comments
 (0)