Class OcrProgressEventsArgs

An event allowing developers to track and display progress of longer OCR jobs.

Use the OcrProgress event to receive detailed notifications of ocr job progress.

Inheritance
System.Object
OcrProgressEventsArgs
Namespace: IronOcr.Events
Assembly: IronOcr.dll
Syntax
public class OcrProgressEventsArgs : EventArgs

Constructors

OcrProgressEventsArgs()

Declaration
public OcrProgressEventsArgs()

Properties

Duration

The time taken for the entire OCR job. The counter stops when OCR is complete on every page.

Declaration
public TimeSpan Duration { get; }
Property Value
Type Description
System.TimeSpan

EndTimeUTC

The DateTime at which the Read(OcrInputBase) OCR job was 100% completed in UTC format.

null while OCR is still in progress

Declaration
public Nullable<DateTime> EndTimeUTC { get; }
Property Value
Type Description
System.Nullable<System.DateTime>

PagesComplete

The number of pages where OCR 'reading' has been fully completed. They are normally processed in parallel across multiple CPU cores.

Declaration
public int PagesComplete { get; }
Property Value
Type Description
System.Int32

ProgressPercent

OCR job progress as a percentage of pages completed. Values range from 0 to 100.

Declaration
public int ProgressPercent { get; }
Property Value
Type Description
System.Int32

StartTimeUTC

The DateTime at which the Read(OcrInputBase) OCR job started in UTC format.

Declaration
public DateTime StartTimeUTC { get; }
Property Value
Type Description
System.DateTime

TotalPages

The total number of pages being OCR 'read' by Read(OcrInputBase) method class.

Declaration
public int TotalPages { get; }
Property Value
Type Description
System.Int32

See Also