Overloads Sub Run( _
   ByVal imageFileName As String, _
   ByVal documentFileName As String, _
   ByVal format As DocumentFormat, _
   ByVal zonesFileName As String, _
   ByVal callback As OcrProgressCallback _
) 

Visual Basic (Usage)	Copy Code
Dim instance As IOcrAutoRecognizeManager Dim imageFileName As String Dim documentFileName As String Dim format As DocumentFormat Dim zonesFileName As String Dim callback As OcrProgressCallback   instance.Run(imageFileName, documentFileName, format, zonesFileName, callback)

void Run( 
   string imageFileName,
   string documentFileName,
   DocumentFormat format,
   string zonesFileName,
   OcrProgressCallback callback
)

void Run( 
   String^ imageFileName,
   String^ documentFileName,
   DocumentFormat format,
   String^ zonesFileName,
   OcrProgressCallback^ callback
) 

Parameters

imageFileName

The name of the file containing the image.

documentFileName

The name of the result document file.

format

The output document format. If this parameter 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.

zonesFileName

Optional name of prepared multi-page zone file. This parameter can be a null (Nothing in Visual Basic) reference.

callback

Optional callback to show operation progress.

This method will perform the following operations:

1. The IOcrAutoRecognizeManager.JobStarted event is triggered.

2. Creates one ore more IOcrDocument object to store the pages into. The number of OCR documents created is dependant on MaximumThreadsPerJob. If this value is 0 (maximum CPUs/cores) or is greater than 1 and multiple threads is supported by this engine, then more than one document might be created to participate in the recognition process.

3. Loops through all the pages in imageFileName and for each page:

   The page is added to its document using IOcrPageCollection.AddPage.

   If zonesFileName contains a valid multi-page zone file name and has an entry for the current page, then the zones are loaded with IOcrPage.LoadZones(fileName, pageNumber) and applied to the page. If zonesFileNames is a null (Nothing in Visual Basic) reference or it does not contain an equivalant page number, auto-decomposing of the page is performed instead with IOcrPage.AutoZone.

   IOcrPage.Recognize is called to get the OCR data of the page.

   If multiple documents are used or current number of recognized pages is greater than the maximum specified in MaximumPagesBeforeLtd, then current recognition data is saved to a temporary LTD file and the OCR document is cleared.

4. When all pages are processed their saved to result file name specified in documentFileName using the format specified in format. If LTD was used, the temporary file is converted to the final document using DocumentWriter.Convert and optionally DocumentWriter.AppendLtd.

5. All OCR documents and temporary files are deleted.

6. The IOcrAutoRecognizeManager.JobCompleted event is triggered.

7. You can use the IOcrAutoRecognizeManager.JobProgress event or callback to show the operation progress or to abort it if threading is not used. For more information and an example, refer to Leadtools.Forms.Ocr.OcrProgressCallback.

8. You can use the IOcrAutoRecognizeManager.JobOperation event to get information regarding the current operation being performed. For more information and an example, refer to IOcrAutoRecognizeManager.JobOperation.

The IOcrAutoRecognizeManager interface also has the following options to use with this method:

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

Reference