The OcrAutoRecognizeJobOperationEventArgs Class is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.
Data for the IOcrAutoRecognizeManager.JobOperation event.
Object Model
Syntax
| Visual Basic (Declaration) | |
|---|---|
<SerializableAttribute()> Public Class OcrAutoRecognizeJobOperationEventArgs Inherits System.EventArgs | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As OcrAutoRecognizeJobOperationEventArgs | |
| C# | |
|---|---|
[SerializableAttribute()] public class OcrAutoRecognizeJobOperationEventArgs : System.EventArgs | |
| C++/CLI | |
|---|---|
[SerializableAttribute()] public ref class OcrAutoRecognizeJobOperationEventArgs : public System.EventArgs | |
Example
Remarks
IOcrAutoRecognizeManager.JobOperation will trigger when Run, IOcrAutoRecognizeManager.RunJob or IOcrAutoRecognizeManager.RunJobAsync is called.
You can use this event to get information on the current operation (creating an OCR document, loading a page, zoning, recognizing, saving, etc.).
This class contains the following members:
| Member | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Status |
The status of the job. You can set this from the default value of OcrAutoRecognizeManagerJobStatus.Success to OcrAutoRecognizeManagerJobStatus.Abort to abort the recognition process. |
Job |
(Read only) The instance of the IOcrAutoRecognizeJob currently being run. You can use this member to get information about the job, for example, the image file name and page numbers to recognize and the output document file name and format through IOcrAutoRecognizeJob.JobData. Note that OcrAutoRecognizeJobData.LastPageNumber will have the true value of the last page number in the image file if a value of -1 (for up to last page) was passed in the original object used to create IOcrAutoRecognizeJob. |
PostOperation |
(Read only) A boolean value that indicates whether the engine is preparing to run the operation (the value of PostOperation is false) or if the operation has already ran (the value of PostOperation is true). This useful if you want o manipulate the operation data as shown in the example. |
Operation |
(Read only) An OcrAutoRecognizeManagerJobOperation enumeration member that specifies the current operation. |
Document |
(Read only) An IOcrDocument instance that specifies the OCR document being used in the current operation. This object is not valid and will be null (Nothing in Visual Basic) when the current operation is ConvertDocument (or in CreateDocument with PostOperation equals to false). |
Page |
(Read only) an IOcrPage instance that specifies the OCR page being used in the current operation. This object is not valid and will be null (Nothing in Visual Basic) when the current operation is CreateDocument, PrepareDocument, SaveDocument or ConvertDocument. |
ImagePageNumber |
(Read only) The page number in the input (image) file name for the current operation. This member is not valid and will be 0 when the current operation is CreateDocument, PrepareDocument, SaveDocument or ConvertDocument. |
LtdFileName |
(Read only) The name of the LEAD Temporary Document (LTD) being used in the current operation. Depending on how the IOcrAutoRecognizeManager was setup, the engine might create LTD files during the recognition process to support multi-threading or recognition of images with large amount of pages. The value of this member is valid only when the current operation is SavePage (as the LTD for this page), AppendLtd (as the source file name) or ConvertDocument (as the source file name). |
Format |
(Read only) An Leadtools.Forms.DocumentWriters.DocumentFormat enumeration member that specifies the format being used in the current operation. This member will be equal to the original OcrAutoRecognizeJobData.Format value except for the following operations: SavePage and AppendLtd where it will be DocumentFormat.Ltd or SaveDocument where it can either be the original format or DocumentFormat.Ltd if LTD is being used to create a temporary document during recognition. |
DocumentFileName |
(Read only) The name of the document file being saved in the current operation. This member will be equal to the original OcrAutoRecognizeJobData.DocumentFileName value except for the following operations: SavePage and AppendLtd where it will be destination file name or SaveDocument where it can either be the original document file name or the name of a temporary LTD file if LTD is being used to create a temporary document during recognition. |
DocumentWriterInstance |
(Read only) The Leadtools.Forms.DocumentWriters.DocumentWriter instance being used in the current operation. This member will be equal to IOcrDocument.DocumentWriterInstance in all operations where an Document is avaliable. When the operation is ConvertDocument, this instance will point to the Leadtools.Forms.DocumentWriters.DocumentWriter object being used to convert the document. |
Inheritance Hierarchy
System.Object
System.EventArgs
Leadtools.Forms.Ocr.OcrAutoRecognizeJobOperationEventArgs
Requirements
Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7