From 64e9d1558b9bbd625891c8093e8b5954c9e866c6 Mon Sep 17 00:00:00 2001 From: Mugesh Date: Mon, 13 Jul 2026 17:01:05 +0530 Subject: [PATCH 1/4] Updated Licensing Documentation Page --- .../licensing-faq/CI-license-validation.md | 61 ++++++++++++------- 1 file changed, 39 insertions(+), 22 deletions(-) diff --git a/wpf/Licensing/licensing-faq/CI-license-validation.md b/wpf/Licensing/licensing-faq/CI-license-validation.md index 5826dd3686..618d85eb6c 100644 --- a/wpf/Licensing/licensing-faq/CI-license-validation.md +++ b/wpf/Licensing/licensing-faq/CI-license-validation.md @@ -19,16 +19,24 @@ margin-top: 1.5em; margin-bottom: 1.5em; # Syncfusion license key validation in CI services -Syncfusion license key validation in CI services ensures that Syncfusion Essential Studio components are properly licensed during CI processes. Validating the license key at the CI level can prevent licensing errors during deployment. Set up the continuous integration process to fail in case the license key validation fails. Validate the passed parameters and the registered license key again to resolve the issue. +Syncfusion license key validation in CI services ensures that Syncfusion Essential Studio components are properly licensed during CI processes. Validating the license key at the CI level can prevent licensing errors during deployment. You can validate the license key using the `LicenseKeyValidator` utility or programmatically using the `ValidateLicense` method. The following section shows how to validate the Syncfusion license key in CI services. * Download and extract the LicenseKeyValidator.zip utility from the following link: [LicenseKeyValidator](https://s3.amazonaws.com/files2.syncfusion.com/Installs/LicenseKeyValidation/LicenseKeyValidator.zip). -* Open the LicenseKeyValidation.ps1 PowerShell script in a text\code editor as shown in the below example. +* Open the LicenseKeyValidation.ps1 PowerShell script in a text or code editor as shown in the example below. {% tabs %} -{% highlight c# tabtitle="PowerShell" %} +{% highlight c# tabtitle="v34.1.29 and later" %} +# Replace the parameters with the desired platform, version, and actual license key. + +$result = & $PSScriptRoot"\LicenseKeyValidatorConsole.exe" /platform:"UIComponent" /version:"34.1.29" /licensekey:"Your License Key" + +Write-Host $result +{% endhighlight %} + +{% highlight c# tabtitle="Before v34.1.29" %} # Replace the parameters with the desired platform, version, and actual license key. $result = & $PSScriptRoot"\LicenseKeyValidatorConsole.exe" /platform:"WPF" /version:"26.2.4" /licensekey:"Your License Key" @@ -37,15 +45,13 @@ Write-Host $result {% endhighlight %} {% endtabs %} -![LicenseKeyValidation script](licensing-images/license-validation.png) +* Update the parameters in the script: + + **Platform:** Set /platform:"**UIComponent**" for v34.1.29 and later, or /platform:"**WPF**" for earlier versions (use the relevant Syncfusion platform as needed). -* Update the parameters in the LicenseKeyValidation.ps1 script file as described below. + **Version:** Set the value for /version: to the required version (for example, "26.2.4"). - **Platform:** Modify the value for /platform: to the actual platform "WPF". - - **Version:** Change the value for /version: to the required version (e.g., "26.2.4"). - - **License Key:** Replace the value for /licensekey: with your actual license key (e.g., "Your License Key"). + **License Key:** Replace the value for /licensekey: with your actual license key. N> This feature is supported only from the 16.2.0.41 version of the Essential Studio. @@ -81,7 +87,7 @@ steps: ![LicenseKeyValidation script](licensing-images/license-validation-classic.png) -## GitHub actions +## GitHub Actions * To execute the script in PowerShell as part of a GitHub Actions workflow, include a step in the configuration file and update the path of the LicenseKeyValidation.ps1 script file (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1). @@ -123,31 +129,42 @@ pipeline { {% endhighlight %} {% endtabs %} -## Validate the License Key By Using the ValidateLicense() Method +## Validate the License Key by Using the ValidateLicense() Method * Register the license key properly by calling RegisterLicense("License Key") method with the license key. -* Once the license key is registered, it can be validated by using the ValidateLicense("Platform.WPF") method. This ensures that the license key is valid for the platform and version you are using. For reference, please check the following example. +* Once the license key is registered, it can be validated by using the `ValidateLicense(Platform.WPF)` method. This ensures that the license key is valid for the platform and version you are using. For reference, please check the following example. {% tabs %} -{% highlight c# %} +{% highlight c# tabtitle="v34.1.29 and later" %} +using Syncfusion.Licensing; + +// Register the Syncfusion license key +SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY"); + +//Validate the registered license key. +// The array overload allows validating against multiple platforms in a single call. +bool isValid = SyncfusionLicenseProvider.ValidateLicense(new[] { Platform.UIComponent }); +{% endhighlight %} + +{% highlight c# tabtitle="Before v34.1.29" %} using Syncfusion.Licensing; -//Register Syncfusion license key -Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY"); +// Register the Syncfusion license key +SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY"); -//Validate the registered license key +// Validate the registered license key bool isValid = SyncfusionLicenseProvider.ValidateLicense(Platform.WPF); {% endhighlight %} {% endtabs %} -![LicenseKeyValidationMethod](licensing-images/license-validation-method.png) +N> Use `Platform.UIComponent` for UI component license validation in v34.1.29 and later. `Platform.WPF` is not supported from v34.1.29 onwards. -* If the ValidateLicense() method returns true, registered license key is valid and can proceed with deployment. +* If the ValidateLicense() method returns true, the registered license key is valid and the application can proceed with deployment. -* If the ValidateLicense() method returns false, there will be invalid license errors in deployment due to either an invalid license key or an incorrect assembly or package version that is referenced in the project. Please ensure that all the referenced Syncfusion assemblies or NuGet packages are all on the same version as the license key’s version before deployment. +* If the ValidateLicense() method returns false, invalid license errors will occur during deployment. This is caused by either an invalid license key or an incorrect assembly or package version referenced in the project. Ensure that all referenced Syncfusion assemblies or NuGet packages match the version of the license key before deployment. -## Validate the License Key By Using the Unit Test Project +## Validate the License Key by Using the Unit Test Project * To create a unit test project in Visual Studio, choose **File -> New -> Project** from the menu. This opens a new dialog for creating a new project. Filtering the project type by Test or typing Test as a keyword in the search option can help you to find available unit test projects. Select the appropriate test framework (such as MSTest, NUnit, or xUnit) that best suits your need. @@ -159,7 +176,7 @@ bool isValid = SyncfusionLicenseProvider.ValidateLicense(Platform.WPF); 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. -* Once the license key is registered, it can be validated by using the ValidateLicense("Platform.WPF", out var validationMessage) method. This ensures that the license key is valid for the platform and version you are using. +* Once the license key is registered, it can be validated by using the `ValidateLicense(Platform.WPF, out var validationMessage)` method (available in v34.1.29 and later). This ensures that the license key is valid for the platform and version you are using. * For reference, please check the following example that demonstrates how to register and validate the license key in the unit test project. From 55e5969d30904d1f9db933e9552fb050f536b1e1 Mon Sep 17 00:00:00 2001 From: Paranthaman Palani Date: Fri, 17 Jul 2026 17:58:51 +0530 Subject: [PATCH 2/4] Moved the staging changes to live --- .../how-to-register-in-an-application.md | 28 ++++++++++++++++--- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/wpf/Licensing/how-to-register-in-an-application.md b/wpf/Licensing/how-to-register-in-an-application.md index 73a47210dc..e2ef96a20a 100644 --- a/wpf/Licensing/how-to-register-in-an-application.md +++ b/wpf/Licensing/how-to-register-in-an-application.md @@ -7,22 +7,42 @@ control: Essential Studio documentation: ug --- -# Register Syncfusion License key in WPF application +# Register Syncfusion license key in a WPF application The generated license key is just a string that needs to be registered before any Syncfusion control is initiated. The following code is used to register the license. +**Registering a single license key** + {% tabs %} {% highlight c# %} Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY"); {% endhighlight %} {% endtabs %} -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. -* Syncfusion license validation is done offline during application execution and does not require internet access. Apps registered with a Syncfusion license key can be deployed on any system that does not have an internet connection. +**Registering multiple license keys** + +You can register multiple license keys using either a comma (,) or a semicolon (;) as the separator between keys. + +{% tabs %} +{% highlight c# %} +Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY_1,YOUR LICENSE KEY_2,..."); +{% endhighlight %} +{% endtabs %} + +or + +{% tabs %} +{% highlight c# %} +Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY_1;YOUR LICENSE KEY_2;..."); +{% endhighlight %} +{% endtabs %} + +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 (see the package name in the Prerequisites note above). +* Syncfusion license validation is done offline during application execution and does not require internet access. Apps registered with a Syncfusion license key can be deployed on any system that does not have an internet connection. I> Syncfusion 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://help.syncfusion.com/wpf/licensing/licensing-faq/ci-license-validation) section for detailed instructions on how to implement it. -### WPF +### WPF You can register the license key in App constructor of **App.xaml.cs** in C#. If App constructor not available in **App.xaml.cs**, create the "App()" constructor in **App.xaml.cs** and register the license key inside the constructor. In Visual Basic, register the license code in **App.xaml.vb**. From 08dc8e20864cf9797a712cfeb9933509a61f041c Mon Sep 17 00:00:00 2001 From: Dharunkumar Sundaravadivel Date: Tue, 28 Jul 2026 10:57:50 +0530 Subject: [PATCH 3/4] Task(ES--1039222)-Update GridControl/Getting-Started.md --- wpf/GridControl/Getting-Started.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/wpf/GridControl/Getting-Started.md b/wpf/GridControl/Getting-Started.md index 60a6f3f133..d1d898bbfd 100644 --- a/wpf/GridControl/Getting-Started.md +++ b/wpf/GridControl/Getting-Started.md @@ -23,7 +23,7 @@ N> Refer [Choose between different Grid's](https://help.syncfusion.com/wpf/datag ## Adding the Grid Control to a WPF Application -In this section, we will see how to add the Grid control to a WPF application and load random data. The Grid control can be added to an application through one of the following methods: through a designer or programmatically. +In this section, we will see how to add the Grid control to a WPF application and load random data. The Grid control can be added to an application through one of the following methods: through a designer, programmatically, or by installing the required NuGet packages. ### Adding the Grid Control through a Designer @@ -47,7 +47,7 @@ Please follow the steps below to add the Grid control through a designer. ### Programmatically Adding the Grid Control -Instead of adding it through a designer such a Visual Studio, you can add the Grid control programmatically. +Instead of adding it through a designer such a Visual Studio, you can add the Grid control programmatically using either the NuGet package or direct assembly references. 1. Create a new WPF application. @@ -123,7 +123,7 @@ for (int i = 0; i < 100; i++) {{ codesnippet3 | OrderList_Indent_Level_1 }} -2. You can populate data by handling the QueryCellInfo event of gridControl. This will load the data in and on-demand basis, ensuring optimized performance. +2. You can populate data by handling the QueryCellInfo event of gridControl. This will load the data on demand, ensuring optimized performance, especially when working with millions of rows. Refer to the [Virtualization](https://help.syncfusion.com/wpf/GridControl/virtualization) section for more details. {% capture codesnippet4 %} {% tabs %} From f8fab7bdd2747339f967f288e8773eb2b60ff1eb Mon Sep 17 00:00:00 2001 From: Dharunkumar Sundaravadivel Date: Tue, 28 Jul 2026 19:18:23 +0530 Subject: [PATCH 4/4] Task(ES--1039222)-Updates the grammatical Corrections. --- wpf/GridControl/Getting-Started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wpf/GridControl/Getting-Started.md b/wpf/GridControl/Getting-Started.md index d1d898bbfd..20ca88e769 100644 --- a/wpf/GridControl/Getting-Started.md +++ b/wpf/GridControl/Getting-Started.md @@ -47,7 +47,7 @@ Please follow the steps below to add the Grid control through a designer. ### Programmatically Adding the Grid Control -Instead of adding it through a designer such a Visual Studio, you can add the Grid control programmatically using either the NuGet package or direct assembly references. +Instead of adding it through the Visual Studio Designer, you can add the Grid control programmatically using either a NuGet package or direct assembly references. 1. Create a new WPF application.