LEADTOOLS OCR (Leadtools.Forms.Ocr assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
OcrAutoRecognizeJobData Constructor(String,Int32,Int32,DocumentFormat,String)
See Also 
Leadtools.Forms.Ocr Namespace > OcrAutoRecognizeJobData Structure > OcrAutoRecognizeJobData Constructor : OcrAutoRecognizeJobData Constructor(String,Int32,Int32,DocumentFormat,String)



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 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.
format
The output document format. This can be any of the supported Leadtools.Forms.DocumentWriters.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).

The OcrAutoRecognizeJobData Constructor(String,Int32,Int32,DocumentFormat,String) is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

Initializes a new instance of OcrAutoRecognizeJobData with the specified parameters.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal imageFileName As String, _
   ByVal firstPageNumber As Integer, _
   ByVal lastPageNumber As Integer, _
   ByVal format As DocumentFormat, _
   ByVal documentFileName As String _
)
Visual Basic (Usage)Copy Code
Dim imageFileName As String
Dim firstPageNumber As Integer
Dim lastPageNumber As Integer
Dim format As DocumentFormat
Dim documentFileName As String
 
Dim instance As New OcrAutoRecognizeJobData(imageFileName, firstPageNumber, lastPageNumber, format, documentFileName)
C# 
public OcrAutoRecognizeJobData( 
   string imageFileName,
   int firstPageNumber,
   int lastPageNumber,
   DocumentFormat format,
   string documentFileName
)
C++/CLI 
public:
OcrAutoRecognizeJobData( 
   String^ imageFileName,
   int firstPageNumber,
   int lastPageNumber,
   DocumentFormat format,
   String^ documentFileName
)

Parameters

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 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.
format
The output document format. This can be any of the supported Leadtools.Forms.DocumentWriters.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).

Example

Remarks

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

Member Value
ImageFileName

imageFileName

FirstPageNumber

firstPageNumber

LastPageNumber

lastPageNumber

ZonesFileName

null (Nothing in Visual Basic)

Format

format

DocumentFileName

documentFileName

OcrAutoRecognizeJobData.JobName

null (Nothing in Visual Basic)

OcrAutoRecognizeJobData.UserData

null (Nothing in Visual Basic)

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

OcrAutoRecognizeJobData Constructor(String,Int32,Int32,DocumentFormat,String) requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features