1. IronXL
  2. How-Tos
  3. Using License Keys

Using IronXL License Keys

How to Get a License Key

Adding an IronXL license key allows you to deploy your project live without restrictions or watermarks.

You can buy a license here or sign up for a free 30 day trial key here.

Step 1: Download the Latest Version of IronXL

C# NuGet Library for Excel

Install with NuGet

Install-Package IronXL.Excel
nuget.org/packages/IronXL.Excel/
or
C# Excel DLL

Download DLL

Download DLL

Manually install into your project

The first thing we need to do is install the IronXL.Excel library, adding Excel functionality to the .NET framework.

Install with NuGet Package

  1. In Visual Studio, right-click on the project select "Manage NuGet Packages ..."
  2. Search for the IronXL.Excel package and install

Or

  1. Enter the Package Manager Console
  2. Type > Install-Package IronXL.Excel
Install-Package IronXL.Excel


View the package on the NuGet site here.

DLL Direct Download Installation

Download the IronXL .NET Excel DLL and manually install into Visual Studio.

Step 2: Apply Your License Key

Set the license key inside your code

Add this code to the startup of your application, before IronXL is used.

IronXL.License.LicenseKey = "IRONXL-MYLICENSE-KEY-1EF01";
IronXL.License.LicenseKey = "IRONXL-MYLICENSE-KEY-1EF01";
IronXL.License.LicenseKey = "IRONXL-MYLICENSE-KEY-1EF01"
VB   C#

Set your key using Web.Config or App.Config in .NET Framework Applications

To apply a key globally to your application using Web.Config or App.Config, add the following key to your config file in appSettings.

<configuration>
...
  <appSettings>
    <add key="IronXL.LicenseKey" value="IronXL-MYLICENSE-KEY-1EF01"/>
  </appSettings>
...
</configuration>
XML

There is a known licensing issue between IronXL version 2023.4.13 - 2024.3.20 on project:

  • ASP.NET projects
  • .NET Framework version >= 4.6.2

The key stored in a Web.config file is NOT being picked up and used by the product. Visit the 'Setting License Key in Web.config' troubleshooting article to learn more.

Ensure that IronXL.License.IsLicensed returns true to verify.

Set your key using a .NET Core appsettings.json file

To apply a key globally to your application to a .NET Core:

  • Add a JSON file to your project called appsettings.json in the root directory of your project
  • Add a 'IronXL.LicenseKey' key to your JSON config file. The value should be your license key.
  • Ensure that the file properties include Copy to Output Directory: Copy always
  • Ensure that IronXL.License.IsLicensed returns true to verify.

File: appsettings.json

{

    "IronXL.LicenseKey":"IronXL-MYLICENSE-KEY-1EF01"

}

Step 3: Test your key

Test if your key has been installed correctly.

// Check if a given license key string is valid.
bool result = IronXL.License.IsValidLicense("IronXL-MYLICENSE-KEY-1EF01");

// Check if IronXL is licensed successfully 
bool is_licensed = IronXL.License.IsLicensed;
// Check if a given license key string is valid.
bool result = IronXL.License.IsValidLicense("IronXL-MYLICENSE-KEY-1EF01");

// Check if IronXL is licensed successfully 
bool is_licensed = IronXL.License.IsLicensed;
' Check if a given license key string is valid.
Dim result As Boolean = IronXL.License.IsValidLicense("IronXL-MYLICENSE-KEY-1EF01")

' Check if IronXL is licensed successfully 
Dim is_licensed As Boolean = IronXL.License.IsLicensed
VB   C#

Note: After adding a license always remember to clean and republish you application to avoid potential mistakes in deployment.

Step 4: Get started with your project

Follow our tutorial on how to Get Started with IronXL.

Questions?

If you have any questions, reach out to support@ironsoftware.com