Class License

Allows IronXL license keys to be applied globally across an application.

Inheritance
System.Object
License
Namespace: IronXL
Assembly: IronXL.dll
Syntax
public static class License : Object

Apply an IronXL license key across a whole application through License. Setting a key here removes the trial watermark and unlocks production use without per-call configuration, so the same value covers every workbook the process touches. It is the static entry point a developer reaches for when moving an IronXL project from evaluation to deployment.

Assign the key once at startup with the static LicenseKey property, before the first WorkBook is created or loaded. A key can also be supplied through a .NET Framework Web.config or App.config file, or through appsettings.json on .NET Core, under the IronXL.LicenseKey name instead of in code. Check IsLicensed to confirm a valid key is active, and call IsValidLicense with a candidate string to test a key before relying on it. DisableAppAnalytics opts the application out of analytics where that is required. Because every member is static, there is nothing to construct and the settings apply globally for the lifetime of the process.

using IronXL;

License.LicenseKey = "YOUR-LICENSE-KEY";
bool active = License.IsLicensed;

The license keys guide walks through applying a key, and the getting started guide sets up a first project.

Properties

IsLicensed

Determines whether this instance of IronXL is Licensed.

Will return false unless a LicenseKey is set to a valid trial or full license key in LicenseKey property, Web.Config, App.Config or appsettings.json in .Net Core.

See https://ironsoftware.com/csharp/excel/licensing/ and https://ironsoftware.com/csharp/excel/docs/license/license-keys/

Declaration
public static bool IsLicensed { get; }
Property Value
Type Description
System.Boolean

true if the license key given is valid.

LicenseKey

Get Licensed at https://ironsoftware.com/csharp/excel/licensing/

For .Net framework applications, a license key can alternatively be added to Web.Config or App.Config XML file using <add key="IronXL.LicenseKey" value="IRONXL-LICENSE-KEY"/> within the appSettings node. See https://ironsoftware.com/csharp/excel/docs/license/license-keys/

For .Net Core applications, a license key may be added to appsettings.json where the key name is "IronXL.LicenseKey" and the value is a valid IronXL trial or full license key.

See https://ironsoftware.com/csharp/excel/licensing/ for licensing options.

Declaration
public static string LicenseKey { get; set; }
Property Value
Type Description
System.String

Methods

DisableAppAnalytics()

Disables AppAnalytics for IronXL. Limitations apply.

Declaration
public static void DisableAppAnalytics()

IsValidLicense(String)

Determines whether a string license is valid upon the validation process

------------------------------------------------

Usage: bool checkValidLicense = IronXL.License.IsValidLicense(IronXL.License.LicenseKey);

------------------------------------------------

Declaration
public static bool IsValidLicense(string licenseKey)
Parameters
Type Name Description
System.String licenseKey

IronXL license key as a string
Returns
Type Description
System.Boolean

true if the license key given is valid and not expired.
Remarks

Important Notes:

❗ Validation Behavior: This method will return false for expired keys, even if they were previously valid. This includes:

  • Expired TEAM KEY
  • Expired Subscription Key
  • Expired Enterprise Key
Related Documentation:

🗝️ Get a Trial Key: Learn more and get a trial key

🗝️ Commercial Licensing: View commercial licensing options

📚 API Reference:Full API Documentation