LEADTOOLS OCR (Leadtools.Forms.Ocr assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
IOcrDocument Interface
See Also  Members  
Leadtools.Forms.Ocr Namespace : IOcrDocument Interface



Defines an OCR document object.

Syntax

Visual Basic (Declaration) 
Public Interface IOcrDocument 
   Inherits IDisposable 
Visual Basic (Usage)Copy Code
Dim instance As IOcrDocument
C# 
public interface IOcrDocument : IDisposable  
C++/CLI 
public interface class IOcrDocument : public IDisposable  

Example

For an example, refer to IOcrDocumentManager and IOcrEngine.

Remarks

The IOcrDocument object holds the recognition data for one or more pages and is used to convert this data to the final output document.

Typical OCR operation using IOcrEngine involves starting up the engine and then creating an IOcrDocument object using the IOcrDocumentManager.CreateDocument method before adding the pages into it and performing either automatic or manual zoning. Once this is done, use the IOcrPage.Recognize method on each page to collect the recognition data and store it internally in the page. After the recognition data is collected, use the various IOcrDocument.Save methods to save the document to its final format. You can also use the various IOcrDocument.SaveXml methods to save the document as XML. For more information, refer to OcrXmlOutputOptions

Use IOcrDocument.Save as many times as required to save the document to multiple formats such PDF, DOC and HTML (As well as XML through the IOcrDocument.SaveXml method). You can also continue to add and recognize pages (through the IOcrPage.Recognize method after you save the document.

For each IOcrPage that is not recognized (the user did not call IOcrPage.Recognize and the value of the page IOcrPage.IsRecognized is still false) the IOcrDocument will insert an empty page into the final document.

To get the low level recognition data including the recognized characters and their confidence, use IOcrPage.GetRecognizedCharacters instead.

The IOcrDocument interface implements System.IDisposable, hence you must dispose the IOcrDocument object as soon as you are finished using it. Disposing an IOcrDocument object will free all the pages stored inside its IOcrDocument.Pages collection.

Some OCR engine types support creating multi-threaded documents by creating one IOcrEngine and multiple IOcrDocument or IOcrAutoRecognizeJob each in its own dedicated threads. For more information, refer to Multi-Threading with LEADTOOLS OCR.

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

IOcrDocument requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features