←Select platform

OcrAutoRecognizeJobData Structure


Contains the data used to create an OCR Auto Recognition job.

public struct OcrAutoRecognizeJobData 
Public Structure OcrAutoRecognizeJobData  
   Inherits System.ValueType 
@interface LTOcrAutoRecognizeJobData : NSObject 
public class OcrAutoRecognizeJobData 
public value class OcrAutoRecognizeJobData : public System.ValueType  


Use this structure to specify the input data for an OCR job. After creating an instance of OcrAutoRecognizeJobData with the data, pass it to IOcrAutoRecognizeManager.CreateJob to create an IOcrAutoRecognizeJob object. Then use the IOcrAutoRecognizeJob object with the IOcrAutoRecognizeManager.RunJob and IOcrAutoRecognizeManager.RunJobAsync methods to run and monitor an OCR job.

The OcrAutoRecognizeJobData structure contains the following members:

Member Description
ImageFileName and ImageStream

The name of the file or the .NET stream containing the source image. This can be any single or multipage image file format supported by LEADTOOLS. One of these must not be null. If ImageFileName is not null, then it must contain the name of a file currently existing on disk.


1-based index of the first page number in ImageFileName or ImageStream to recognize. Use this and LastPageNumber to recognize only a certain range of pages in the source file. This member must be greater than or equal to 1 (first page in the file).


1-based index of the last page number in ImageFileName or ImageStream to recognize. Use this and FirstPageNumber to recognize only a certain range of pages in the source file. Use a value of -1 to indicate "up to last page in the file"; otherwise, this member must be a value greater than or equal to FirstPageNumber, up to the maximum number of pages in the source file name.


Optional name of prepared multipage zone file. This member can be a null (Nothing in Visual Basic) reference. When no zone file is specified, the IOcrAutoRecognizeManager will auto-detect the zones for each page using IOcrPage.AutoZone.


The output document format, which can be any of the supported DocumentFormats such as PDF, DOC and TEXT. If this member is DocumentFormat.User, then the document id saved using the native engine format set in IOcrDocumentManager.EngineFormat if the engine used supports native formats; otherwise, an exception will be thrown.

DocumentFileName and DocumentStream

The name of the output document file or the .NET stream to use for output. When recognition is completed, this file will be created on disk. One of these must not be null.


Optional job name. If tracing is enabled with IOcrAutoRecognizeManager.EnableTrace, then the engine will use its value in the trace messages. If this member is a null reference (Nothing in Visual Basic), then the trace will show the generic [Untitled] name next to the trace messages.


Optional user data associated with the job. Use this value to store any extra information required by your application. The IOcrAutoRecognizeJob will contain the same object used here in its IOcrAutoRecognizeJob.JobData member.


For an example, refer to RunJob and RunJobAsync.


Target Platforms

Help Version 20.0.2020.4.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Ocr Assembly