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

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.

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

Step 1: Download the Latest Version of IronPDF

C# NuGet Library for PDF

Install with NuGet

Install-Package IronPdf
nuget.org/packages/IronPdf/
or
Java PDF JAR

Download DLL

Download DLL

Manually install into your project

C# NuGet Library for PDF

Install with NuGet

Install-Package IronPdf
nuget.org/packages/IronPdf/
or
Java PDF JAR

Download DLL

Download DLL

Manually install into your project

Start using IronPDF in your project today with a free trial.

First Step:
green arrow pointer

Check out IronPDF on Nuget for quick installation and deployment. With over 8 million downloads, it's transforming PDF with C#.

C# NuGet Library for PDF nuget.org/packages/IronPdf/
Install-Package IronPdf

Consider installing the IronPDF DLL directly. Download and manually install it for your project or GAC form: IronPdf.zip

Manually install into your project

Download DLL

Install via NuGet

In Visual Studio, right click on your project 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 and above. It will also work just as well in VB.NET projects.

Install-Package IronPdf

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;
using IronPdf;
Imports IronPdf
VB   C#

Step 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.

IronPdf.License.LicenseKey = "YOUR-IRONPDF-LICENSE-KEY";
IronPdf.License.LicenseKey = "YOUR-IRONPDF-LICENSE-KEY";
IronPdf.License.LicenseKey = "YOUR-IRONPDF-LICENSE-KEY"
VB   C#

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 <appSettings> element.

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

There is a known licensing issue between IronPdf version 2023.4.4 - 2024.3.3 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 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.json in the root directory of your project
  • Add a '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.IsLicensed returns true to 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

  1. 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.
  2. Under Settings in the left pane, select Configuration.
  3. Select Application settings and click New Application setting.

  4. Add Name and Value as the following:

    Name - IronPdf.LicenseKey

    Value - YOUR-LICENSE-KEY

  5. 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;
// 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;
' Check if a given license key string is valid.
Dim result As Boolean = IronPdf.License.IsValidLicense("IRONPDF-MYLICENSE-KEY-1EF01")

' Check if IronPDF is licensed successfully 
Dim is_licensed As Boolean = IronPdf.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 IronPDF.

Questions?

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