Class License

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

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

Activating IronQR across an application runs through License, the static entry point for license keys. Set License.LicenseKey to your key once at application startup, before any QR code is read or written, and the key applies globally for the process. A valid license removes the trial limits from generated and scanned codes.

Three more members support the workflow. License.IsLicensed returns whether a valid key is currently applied, which works well as a startup smoke test. License.IsValidLicense(string licenseKey) checks a key string without applying it, so a configuration value can be validated before it is set. License.DisableAppAnalytics() opts the application out of anonymous usage reporting.

Because the members are static, set the key in one place such as Program.cs or a startup hook rather than before each operation. Confirm IsLicensed returns true in a smoke test so a missing or mistyped key surfaces during development. The license keys guide explains where to obtain and place the key.

using IronQr;

License.LicenseKey = "IRONQR.MYLICENSE.KEY.1EF01";
bool licensed = License.IsLicensed;

The get started guide covers first-run setup for a new IronQR project.

Properties

IsLicensed

Determines whether this instance of IronQR 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/qr/licensing/ and https://ironsoftware.com/csharp/qr/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/qr/licensing/

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

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

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

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

Methods

DisableAppAnalytics()

Disables AppAnalytics for IronQr. Limitations apply.

Declaration
public static void DisableAppAnalytics()

IsValidLicense(String)

Determines whether a string license is valid upon the validation process

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

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

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

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

IronQr 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