IronPDF License Keys
How to Get a License Key
Adding an IronPDF license key allows you to develop and deploy your project live without restrictions.
Start using IronPDF in your project today with a free trial.
Step 1: Download the Latest Version of IronPDF
Install via NuGet
In Visual Studio, right-click on your project in the Solution Explorer and select "Manage NuGet Packages...". From there, simply search for IronPDF and install the latest version. Click "OK" to any dialog boxes that come up.
This will work in any C# .NET Framework project from Framework 4.6.2 and above, or .NET Core 2.0 and above. It will also work in VB.NET projects.
https://www.nuget.org/packages/IronPdf
Install via DLL
Alternatively, the IronPDF DLL can be downloaded and manually installed to the project or GAC from https://ironpdf.com/packages/IronPdf.zip
Remember to add this statement to the top of any .cs class file using IronPDF:
using IronPdf;Imports IronPdfStep 2: Apply Your License Key
Set your IronPDF license key using code
Add this code to the startup of your application, before IronPDF is used. This method is universally effective and straightforward. It works for .NET Core and also for .NET Framework applications.
// Set the IronPdf license key
IronPdf.License.LicenseKey = "IRONPDF-MYLICENSE-KEY-1EF01";' Set the IronPdf license key
IronPdf.License.LicenseKey = "IRONPDF-MYLICENSE-KEY-1EF01"You can validate that your software is licensed using either IronPdf.License.IsValidLicense(string LicenseKey) or the IronPdf.License.IsLicensed property.
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 the <appSettings> element.
<configuration>
<appSettings>
<add key="IronPdf.LicenseKey" value="IRONPDF-MYLICENSE-KEY-1EF01"/>
</appSettings>
</configuration>There is a known licensing issue between IronPDF version 2023.4.4 and 2024.3.3 in 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 IronPdf.License.IsLicensed returns true to verify.
Set your key using a .NET Core appsettings.json file
To apply a key globally to your application with .NET Core:
- Add a JSON file to your project called
appsettings.jsonin the root directory of your project. - Add an 'IronPdf.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
IronPdf.License.IsLicensedreturnstrueto verify.
File: appsettings.json
{
"IronPdf.LicenseKey": "IRONPDF-MYLICENSE-KEY-1EF01"
}Set your key in Azure Functions
Local
Add the license key into local.settings.json:
{
"IsEncrypted": false,
"Values": {
"AzureWebJobsStorage": "UseDevelopmentStorage=true",
"FUNCTIONS_WORKER_RUNTIME": "dotnet",
"IronPdf.LicenseKey": "YOUR-LICENSE-KEY"
}
}Deployment
-
Go to the Azure portal and sign in to your Azure account. In the search bar at the top of the portal, enter the name of your function app and select it from the list.
-
Under Settings in the left pane, select Configuration.
-
Select Application settings and click "New Application setting."
-
Add Name and Value as follows:
Name: IronPdf.LicenseKeyValue: YOUR-LICENSE-KEY
-
Save it.
Step 3: Test if your key has been installed correctly
// Check if a given license key string is valid
bool result = IronPdf.License.IsValidLicense("IRONPDF-MYLICENSE-KEY-1EF01");
// Check if IronPDF is licensed successfully
bool is_licensed = IronPdf.License.IsLicensed;Imports IronPdf
' Check if a given license key string is valid
Dim result As Boolean = License.IsValidLicense("IRONPDF-MYLICENSE-KEY-1EF01")
' Check if IronPDF is licensed successfully
Dim is_licensed As Boolean = 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 IronPDF.
Questions?
If you have any questions, reach out to support@ironsoftware.com
Frequently Asked Questions
How do I install IronPDF via NuGet in Visual Studio?
To install IronPDF via NuGet in Visual Studio, right-click on your project in the Solution Explorer and select 'Manage NuGet Packages...'. Then, search for IronPDF and install the latest version. This method works for C# .NET Framework projects from Framework 4.6.2 upward, .NET Core 2.0 and above, and also VB.NET projects.
Can I install IronPDF using a DLL file instead of NuGet?
Yes, you can install IronPDF using a DLL file by downloading the IronPDF DLL and manually adding it to your project or GAC from https://ironpdf.com/packages/IronPdf.zip.
How do I apply my IronPDF license key using code?
To apply your IronPDF license key using code, add the following line to your application startup before using IronPDF: IronPdf.License.LicenseKey = 'YOUR-LICENSE-KEY'; This method is effective for both .NET Core and .NET Framework applications.
How do I apply the IronPDF license key via Web.Config or App.Config?
To apply the IronPDF license key via Web.Config or App.Config in .NET Framework applications, add the following key to the
Is there a known issue when setting the license key in Web.config?
Yes, there is a known licensing issue between IronPDF versions 2023.4.4 and 2024.3.3 in ASP.NET projects and .NET Framework version >= 4.6.2 projects where the key stored in Web.config is not being picked up. Visit the troubleshooting article for more information.
How can I apply the license key in a .NET Core project using appsettings.json?
In a .NET Core project, add a JSON file called 'appsettings.json' to the root directory and include the key 'IronPdf.LicenseKey' with your license value. Ensure the file properties are set to 'Copy to Output Directory: Copy always'. Verify the application is licensed by checking that IronPdf.License.IsLicensed returns true.
How do I add a license key to Azure Functions?
For local Azure Functions, add the license key to local.settings.json. For deployment, go to the Azure portal, select your function app, and add a New Application setting under Configuration with Name 'IronPdf.LicenseKey' and Value as your license key.
How can I test if my IronPDF license key has been installed correctly?
To test if your IronPDF license key has been installed correctly, use the IronPdf.License.IsValidLicense method with your license key string, or check the IronPdf.License.IsLicensed property to confirm a successful license.
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.
