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 key or sign up for a free 30-day trial key here.
Step 1: Download the Latest Version of IronXL
The first thing we need to do is install the IronXL.Excel library, adding Excel functionality to the .NET framework.
Install with NuGet Package
- In Visual Studio, right-click on the project and select "Manage NuGet Packages ..."
- Search for the IronXL.Excel package and install
Or
-
Enter the Package Manager Console
-
Type:
DLL Direct Download Installation
Download the .NET Excel DLL and manually install it 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.
// Set the IronXL license key for your project
IronXL.License.LicenseKey = "IRONXL-MYLICENSE-KEY-1EF01";' Set the IronXL license key for your project
IronXL.License.LicenseKey = "IRONXL-MYLICENSE-KEY-1EF01"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>
<!-- Define the IronXL license key -->
<add key="IronXL.LicenseKey" value="IRONXL-MYLICENSE-KEY-1EF01"/>
</appSettings>
...
</configuration>There is a known licensing issue between IronXL version 2023.4.13 - 2024.3.20 on projects:
- 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 .NET Core application:
- Add a JSON file to your project called
appsettings.jsonin 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.IsLicensedreturnstrueto 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.
Dim result As Boolean = IronXL.License.IsValidLicense("IRONXL-MYLICENSE-KEY-1EF01")
' Check if IronXL is licensed successfully
Dim is_licensed As Boolean = IronXL.License.IsLicensedNote: After adding a license, always remember to clean and republish your 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
Frequently Asked Questions
How do I obtain a license key for IronXL?
You can purchase a license key from the Iron Software website or sign up for a free 30-day trial key to start implementing IronXL in your application.
How can I install IronXL on my .NET project?
IronXL can be installed using the NuGet Package Manager in Visual Studio or by downloading the .NET Excel DLL and manually integrating it into your project.
What is the recommended way to apply an IronXL license key in my code?
Set the IronXL license key in the startup of your application before using IronXL resources, using the command: `IronXL.License.LicenseKey = "YOUR-KEY";`.
Can I set my IronXL license key in a configuration file?
Yes, you can set the IronXL license key in `Web.Config` or `App.Config` for .NET Framework applications, or in the `appsettings.json` file for .NET Core applications.
What should I do if my IronXL license key is not being recognized?
Ensure that `IronXL.License.IsLicensed` returns `true`. If there's a known issue with specific versions, refer to the troubleshooting article related to setting license keys in Web.config.
How do I verify if the IronXL license key is valid?
You can verify your license key by checking if `IronXL.License.IsValidLicense("YOUR-KEY")` returns `true` and if `IronXL.License.IsLicensed` is true.
What are the system requirements for using IronXL?
IronXL can be used in ASP.NET projects and .NET Framework applications version 4.6.2 and above, with some licensing issues in specific versions requiring additional troubleshooting.
What should I remember to do after setting an IronXL license key?
Always clean and republish your application after setting a license key to avoid deployment issues.
Where can I find more IronXL resources or support?
You can follow the IronXL tutorial on their documentation page or contact support at support@ironsoftware.com for assistance.
Curtis Chau holds a Bachelor’s degree in Computer Science (Carleton University) and specializes in front-end development with expertise in Node.js, TypeScript, JavaScript, and React. Passionate about crafting intuitive and aesthetically pleasing user interfaces, Curtis enjoys working with modern frameworks and creating well-structured, visually appealing manuals.
