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
IronWord is available via NuGet as the IronWord package.
- In Visual Studio, right-click on the project and select "Manage NuGet Packages..."
- Search for the
IronWordpackage and install
Or, install via the Package Manager Console:
Step 2: Apply Your License Key
Set your license using code
Add this code to the startup of your application, before IronWord is used.
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>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.jsonin the root directory of your project. - Add an
IronWord.LicenseKeykey 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:
// 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.IsLicensedValidate the License Key
To ensure the validity of your license or trial key, you can use the following code snippet:
// 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.
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 purchasing 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.
Frequently Asked Questions
How do I obtain an IronWord license key?
You can purchase a license key via the Iron Software website or sign up for a free 30-day trial key, allowing you to use IronWord without restrictions or watermarks.
How do I apply an IronWord license key in my C# application?
You can set your IronWord license key programmatically by adding a line of code in your application startup or by configuring it in a Web.Config or App.Config for ASP.NET applications.
Can I use NuGet to install IronWord?
Yes, you can install IronWord via NuGet by searching for the 'IronWord' package in Visual Studio or using the Package Manager Console.
How can I verify if my IronWord license key is applied correctly?
You can check the IronWord.License.IsLicensed property in your code to verify if the license key has been successfully applied.
What should I do if my ASP.NET project is not picking up the license key from Web.Config?
For ASP.NET projects or .NET Framework versions 4.6.2 and above, if the license key is not detected, refer to the troubleshooting article: 'Setting License Key in Web.config' on the Iron Software website.
How do I apply a license key to a .NET Core project using appsettings.json?
Add an 'IronWord.LicenseKey' entry to your appsettings.json file and ensure it is included in the project output directory. This allows for global application of the license key.
Is there a way to validate the IronWord license key programmatically?
Yes, you can use IronWord.License.IsValidLicense method with your license key string to check if it is valid before using IronWord features.
Where can I find a tutorial for getting started with IronWord?
Visit the 'Get Started with IronWord' section on our website for comprehensive tutorials and examples to help you begin using IronWord effectively.
What should I do if my trial license key expires?
If your trial license key expires, you will need to purchase a license key to continue using IronWord in your applications without any limitations.
Where can I find support or ask questions about IronWord?
For inquiries or support, reach out to Iron Software's support team at support@ironsoftware.com, and for detailed documentation, visit the IronWord section on our website.
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.
