Search Results for

    Show / Hide Table of Contents

    Class License

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

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

    Apply an IronOCR license key across an application through License. Setting the key here removes the trial watermark and unlocks the library for every read in the process, so a single assignment at startup covers the whole app. It is the focused, licensing-only entry point, distinct from Installation, which exposes the same licensing members alongside broader install and logging configuration.

    Set LicenseKey once, early, before the first OCR call. IsLicensed then reports whether the running instance is licensed, a quick check to confirm the key took effect, and IsValidLicense validates a candidate key string without committing it. DisableAppAnalytics opts the application out of usage analytics where that is required.

    Because License is static, there is nothing to construct: assign and read its members directly. The same LicenseKey, IsLicensed, and IsValidLicense members are also reachable on Installation, so choose License when licensing is all you need and Installation when you are configuring paths, logging, or dependencies in the same place.

    IronOcr.License.LicenseKey = "IRONOCR-MYLICENSE-KEY-1EF01";
    bool licensed = IronOcr.License.IsLicensed;

    The Iron Tesseract how-to shows a licensed read in context, and the configure and set up Tesseract example sets options around it.

    Properties

    IsLicensed

    Removes watermarks. Determines whether this instance of IronOCR 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/ocr/licensing/ and https://ironsoftware.com/csharp/ocr/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/ocr/licensing/

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

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

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

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

    Methods

    DisableAppAnalytics()

    Disables AppAnalytics for IronOCR. Limitations apply.

    Declaration
    public static void DisableAppAnalytics()

    IsValidLicense(String)

    Determines whether a string license is valid upon the validation process

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

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

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

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

    IronOcr 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

    ☀
    ☾
    Downloads
    • Download with Nuget
    • Start for Free
    In This Article
    Back to top
    Install with Nuget