Using IronWord License Keys

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

IronWord.License.LicenseKey = "IRONWORD.MYLICENSE.KEY.1EF01";

IronWord.License.LicenseKey = "IRONWORD.MYLICENSE.KEY.1EF01"

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"
}

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

// Check if the license key has been applied
bool licensed = IronWord.License.IsLicensed;

' Check if the license key has been applied
Dim licensed As Boolean = IronWord.License.IsLicensed

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

// Check if a given license key string is valid
bool valid = IronWord.License.IsValidLicense("IRONWORD.MYLICENSE.KEY.1EF01");

' Check if a given license key string is valid
Dim valid As Boolean = IronWord.License.IsValidLicense("IRONWORD.MYLICENSE.KEY.1EF01")

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.