IronWord License Key in ASP.NET Configuration

Updated:June 9, 2025

The problem has been resolved as of IronWord version 2024.3.5.

Exception: Unhandled exception. IronSoftware.Exceptions.LicensingException: IronWord must be licensed for development.

For older IronWord versions, specifically those released before version 2024.3.5, there is a known licensing issue in:

ASP.NET projects
.NET Framework version >= 4.6.2

The key stored in a Web.config file will NOT be picked up and used by the product.

Workaround

To address this issue, it is recommended to retrieve the license key from the Web.config file using ConfigurationManager in the code, and then apply it to the License.LicenseKey property.

Example:

<configuration>
  ...
  <appSettings>
    <add key="IronWord.LicenseKey" value="IRONWORD.MYLICENSE.KEY.1EF01"/>
  </appSettings>
  ...
</configuration>

<configuration>
  ...
  <appSettings>
    <add key="IronWord.LicenseKey" value="IRONWORD.MYLICENSE.KEY.1EF01"/>
  </appSettings>
  ...
</configuration>

XML

With the XML file provided above, we can use ConfigurationManager to retrieve the license key value and pass it to the IronWord.License.LicenseKey property.

// Import the necessary namespace for ConfigurationManager
using System.Configuration;

// Retrieve the license key from the AppSettings in Web.config
string licenseKey = ConfigurationManager.AppSettings["IronWord.LicenseKey"];

// Set the license key for IronWord
IronWord.License.LicenseKey = licenseKey;

// Import the necessary namespace for ConfigurationManager
using System.Configuration;

// Retrieve the license key from the AppSettings in Web.config
string licenseKey = ConfigurationManager.AppSettings["IronWord.LicenseKey"];

// Set the license key for IronWord
IronWord.License.LicenseKey = licenseKey;

' Import the necessary namespace for ConfigurationManager
Imports System.Configuration

' Retrieve the license key from the AppSettings in Web.config
Private licenseKey As String = ConfigurationManager.AppSettings("IronWord.LicenseKey")

' Set the license key for IronWord
IronWord.License.LicenseKey = licenseKey

$vbLabelText $csharpLabel

Curtis Chau

Chat with engineering team now

Technical Writer

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.

...

Ready to Get Started?

Nuget Downloads 24,833 | Version: 2025.11 just released

View Licenses