1. IronWord
2. Get Started
3. Using License Keys

Using IronWord License Keys

How to Get a License Key

Adding an IronWord 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 IronWord

Step 2: Apply Your License Key

Set your license using code

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

:path=/static-assets/word/content-code-examples/get-started/license-keys-apply.cs

// THIS CODE SNIPPET IS NOT AVAILABLE!

' THIS CODE SNIPPET IS NOT AVAILABLE!

Set your license using Web.Config or App.Config

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="IronWord.LicenseKey" value="IRONWORD.MYLICENSE.KEY.1EF01"/>
  </appSettings>
</configuration>

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

There is a known licensing issue with IronWord versions released before 2024.3.5 on certain 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 IronWord.License.IsLicensed returns true to verify the license.

Set your license 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.json in the root directory of your project.
• Add an IronWord.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.

File: appsettings.json

{
    "IronWord.LicenseKey": "IRONWORD.MYLICENSE.KEY.1EF01"
}

Step 3: Validate Your License Key

Verify the Installed License Key

To verify whether the license key has been applied correctly, you can check the IsLicensed property. Use the following code snippet:

:path=/static-assets/word/content-code-examples/get-started/license-keys-is-licensed.cs

// THIS CODE SNIPPET IS NOT AVAILABLE!

' THIS CODE SNIPPET IS NOT AVAILABLE!

Validate the License Key

To ensure the validity of your license or trial key, you can use the following code snippet:

:path=/static-assets/word/content-code-examples/get-started/license-keys-is-valid.cs

// THIS CODE SNIPPET IS NOT AVAILABLE!

' THIS CODE SNIPPET IS NOT AVAILABLE!

If the return value is True, it means the key is valid, and you can proceed with using IronWord. However, if the return value is False, it indicates that the key is invalid.

Step 4: Getting Started with Your Project

To get started with IronWord, we highly recommend following our comprehensive tutorial on how to Get Started with IronWord. This tutorial offers detailed instructions and examples to help you grasp the basics of using IronWord.

Questions or Need Support?

To use IronWord in live projects, you'll require a paid or trial license key, which you can obtain by purchase a license. The trial license is available by visiting this link.

For a comprehensive collection of code examples, tutorials, licensing details, and extensive documentation, please visit the IronWord section on our website.

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