Class Installation

A static class providing everything to need to configure the installation and licensing of IronOcr

Inheritance

System.Object

Installation

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: IronOcr

Assembly: IronOcr.dll

Syntax

public static class Installation

Fields

SendAnonymousAnalyiticsAndCrashData

Opt in or out of sending anonymous usage statistics about Iron Software usage and performance to help us improve the product and developer experience.

Usage statistics are never sent in commercially deployed projects(when a license key is applied), only during development usage.

Declaration

public static bool SendAnonymousAnalyiticsAndCrashData

Field Value

Type	Description
System.Boolean

Properties

InstallationPath

A writable directory where setup and temporary files and will be deployed when necessary. The default location is the system temp folder which is appropriate for most use cases

Declaration

public static string InstallationPath { get; set; }

Property Value

Type	Description
System.String

IsLicensed

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 IronOcr.Installation.LicenseKey, Web.Config , App.Config or appsettings.json in .Net Core.

Declaration

public static bool IsLicensed { get; }

Property Value

Type	Description
System.Boolean

LicenseKey

Removes watermarks. Get Licensed at https://ironsoftware.com

Declaration

public static string LicenseKey { get; set; }

Property Value

Type	Description
System.String

LogFilePath

Setting a log path produces ‘log files’ which may be very useful for debugging in production or provided to Iron Software support when reporting an issue.

LogFilePath may be set to a directory name or a full file name.

Setting LogFilePath = null will turn off log files.

Declaration

public static string LogFilePath { get; set; }

Property Value

Type	Description
System.String

See Also

ClearLogFiles()

LoggingMode

Activate or disable detailed developer messages sent to your choice of location in the IDE or application console.

Declaration

public static Installation.LoggingModes LoggingMode { get; set; }

Property Value

Type	Description
Installation.LoggingModes

Methods

ClearLogFiles()

Removes any Iron Software log files at the LogFilePath.

Declaration

public static void ClearLogFiles()

See Also

LogFilePath

IsValidLicense(String)

Checks if a license key is valid.

Declaration

public static bool IsValidLicense(string LicenseKey)

Parameters

Type	Name	Description
System.String	LicenseKey

Returns

Type	Description
System.Boolean	True when a valid key is given.

Inherited members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)