OcrAutoRecognizeJobData Constructor(string,int,int,string,DocumentFormat,string)

Summary

Initializes a new instance of OcrAutoRecognizeJobData with the specified parameters.

Syntax

Objective-C

C++

Java

public OcrAutoRecognizeJobData( 
   string imageFileName, 
   int firstPageNumber, 
   int lastPageNumber, 
   string zonesFileName, 
   DocumentFormat format, 
   string documentFileName 
)

Public Function New( _ 
   ByVal imageFileName As String, _ 
   ByVal firstPageNumber As Integer, _ 
   ByVal lastPageNumber As Integer, _ 
   ByVal zonesFileName As String, _ 
   ByVal format As DocumentFormat, _ 
   ByVal documentFileName As String _ 
)

- (instancetype)initWithImageFile:(NSString *)fileName 
                        firstPage:(NSInteger)firstPage 
                         lastPage:(NSInteger)lastPage 
                        zonesFile:(nullable NSString *)zonesFile 
                           format:(LTDocumentFormat)format 
                     documentFile:(NSString *)documentFile

public OcrAutoRecognizeJobData(String imageFileName, 
                               int firstPageNumber, 
                               int lastPageNumber, 
                               String zonesFileName, 
                               DocumentFormat format, 
                               String documentFileName)

public: 
OcrAutoRecognizeJobData(  
   String^ imageFileName, 
   int firstPageNumber, 
   int lastPageNumber, 
   String^ zonesFileName, 
   DocumentFormat format, 
   String^ documentFileName 
)

Parameters

imageFileName
The name of the file containing the source image. This can be any single or multipage image file format supported by LEADTOOLS. This member cannot be a null reference (Nothing in VB) 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 parameter 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 multipage zone file. This member can be a null (Nothing in VB) 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 is saved using the native engine format set in IOcrDocumentManager.EngineFormat when 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 VB).

Remarks

This constructor will initialize the members of the new OcrAutoRecognizeJobData object as described below:

Member	Value
ImageFileName	imageFileName
FirstPageNumber	firstPageNumber
LastPageNumber	lastPageNumber
ZonesFileName	zonesFileName
Format	format
DocumentFileName	documentFileName
DocumentStream	null
JobName	null (Nothing in Visual Basic)
UserData	null (Nothing in Visual Basic)

Example

For an example, refer to RunJob and RunJobAsync.

Requirements

Target Platforms

Reference

OcrAutoRecognizeJobData Structure

OcrAutoRecognizeJobData Members

Overload List

Programming with the LEADTOOLS .NET OCR

Download our FREE evaluation

Help Version 20.0.2020.4.2