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

Summary

Initializes a new instance of OcrAutoRecognizeJobData with the specified parameters.

Syntax

C++/CLI

Python

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

public:  
   OcrAutoRecognizeJobData( Stream^ imageStream, Int32 firstPageNumber, Int32 lastPageNumber, String^ zonesFileName, DocumentFormat^ format, String^ documentFileName)

__init__(self,imageStream,firstPageNumber,lastPageNumber,zonesFileName,format,documentFileName) # Overloaded constructor

Parameters

imageStream

The stream containing the source image data. This can be any single or multipage image file format supported by LEADTOOLS. This member cannot be a null reference.

firstPageNumber

1-based index of the first page number in imageStream 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 imageStream 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
ImageStream	ImageStream
FirstPageNumber	firstPageNumber
LastPageNumber	lastPageNumber
ZonesFileName	zonesFileName
Format	format
DocumentFileName	documentFileName
DocumentStream	null
JobName	null (Nothing in Visual Basic)
UserData	null (Nothing in Visual Basic)

Requirements

Target Platforms

Reference

OcrAutoRecognizeJobData Structure

OcrAutoRecognizeJobData Members

Overload List

Programming with the LEADTOOLS .NET OCR

Download our FREE evaluation

Help Version 23.0.2024.4.19