The OcrAutoRecognizeJobData Structure is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.
Data used to create an OCR Auto Recognition job.
Object Model
Syntax
| Visual Basic (Declaration) | |
|---|---|
<SerializableAttribute()> Public Structure OcrAutoRecognizeJobData Inherits System.ValueType | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As OcrAutoRecognizeJobData | |
| C# | |
|---|---|
[SerializableAttribute()] public struct OcrAutoRecognizeJobData : System.ValueType | |
| C++/CLI | |
|---|---|
[SerializableAttribute()] public value class OcrAutoRecognizeJobData : public System.ValueType | |
Example
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 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). |
| OcrAutoRecognizeJobData.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. |
| OcrAutoRecognizeJobData.UserData |
Optionsl 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. |
Inheritance Hierarchy
System.Object
System.ValueType
Leadtools.Forms.Ocr.OcrAutoRecognizeJobData
Requirements
Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7