←Select platform

OcrAutoRecognizeJobData Structure

Summary

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

Syntax

Java

Objective-C

C++

[SerializableAttribute()] 
public struct OcrAutoRecognizeJobData

<SerializableAttribute()> 
Public Structure OcrAutoRecognizeJobData  
   Inherits System.ValueType

@interface LTOcrAutoRecognizeJobData : NSObject

public class OcrAutoRecognizeJobData

[SerializableAttribute()] 
public value class OcrAutoRecognizeJobData : public System.ValueType

Remarks

Use this structure to specific the input data for an OCR job. After you create an instance of this structure with the data, you can pass it to IOcrAutoRecognizeManager.CreateJob to create an IOcrAutoRecognizeJob object. You can then use this with the IOcrAutoRecognizeManager.RunJob and IOcrAutoRecognizeManager.RunJobAsync methods to run and monitor an OCR job.

This structure contains the following members:

Member	Description
ImageFileName	The name of the file containing the source image. This can be any single or multi-page image file format supported by LEADTOOLS. This member cannot be a null reference (Nothing in Visual Basic) and must contain the name of an existing file on disk.
FirstPageNumber	1-based index of the first page number in ImageFileName to recognize. You can use this and LastPageNumber to recognize only a certain range of pages in the source file. This member must be greater than or equals to 1 (first page in the file).
LastPageNumber	1-based index of the last page number in ImageFileName to recognize. You can use this and FirstPageNumber to recognize only a certain range of pages in the source file. You can use a value of -1 to indicate "up to last page in the file", otherwise, this member must be a value greater than or equals to FirstPageNumber up to the maximum number of pages in the source file name.
ZonesFileName	Optional name of prepared multi-page 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.
Format	The output document format. This can be any of the supported DocumentFormat such as PDF, DOC and TEXT. If this member is DocumentFormat.User, then the document saved using the native engine format set in IOcrDocumentManager.EngineFormat if the engine used supports native formats, otherwise an exception will be thrown.
DocumentFileName	The name of the output document file. When recognition is completed, this file will be created on disk. This member cannot be a null reference (Nothing in Visual Basic).
JobName	Optional job name. If tracing is enabled with IOcrAutoRecognizeManager.EnableTrace, then the engine will use this 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.
UserData	Optional user data associated with the job. You can 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.

Example

For an example, refer to RunJob and RunJobAsync.

Requirements

Target Platforms

Reference

OcrAutoRecognizeJobData Members

Leadtools.Forms.Ocr Namespace

Programming with the LEADTOOLS .NET OCR

Help Version 19.0.2017.10.27