JobProgress Event

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

event EventHandler<OcrAutoRecognizeJobProgressEventArgs> JobProgress

'Declaration
 
Event JobProgress As EventHandler(Of OcrAutoRecognizeJobProgressEventArgs)

'Usage
 
Dim instance As IOcrAutoRecognizeManager
Dim handler As EventHandler(Of OcrAutoRecognizeJobProgressEventArgs)
 
AddHandler instance.JobProgress, handler

event EventHandler<OcrAutoRecognizeJobProgressEventArgs> JobProgress

add_JobProgress(function(sender, e))
remove_JobProgress(function(sender, e))

event EventHandler<OcrAutoRecognizeJobProgressEventArgs^>^ JobProgress

The event handler receives an argument of type OcrAutoRecognizeJobProgressEventArgs containing data related to this event. The following OcrAutoRecognizeJobProgressEventArgs properties provide information specific to this event.

Property	Description
Data	Gets the event progress data.
Job	Gets the job that triggered the event.

Note, this event will not trigger if multiple threads are used on the same document (the value of MaximumThreadsPerJob is anything else but 1).

This event will occur when Run, RunJob or RunJobAsync is called.

For more information, refer to OcrAutoRecognizeJobProgressEventArgs and OcrProgressCallback.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Private Shared Sub JobProgressExample()
      Dim tifFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif")
      Dim pdfFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.pdf")
      ' Create an instance of the engine
      Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Professional, False)
         ' Start the engine using default parameters
         Console.WriteLine("Starting up the engine...")
         ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing)

         Dim ocrAutoRecognizeManager As IOcrAutoRecognizeManager = ocrEngine.AutoRecognizeManager

         ' Run the job in 1 thread
         ocrAutoRecognizeManager.MaximumThreadsPerJob = 1

         ' Create the job
         Dim ocrJobData As New OcrAutoRecognizeJobData(tifFileName, DocumentFormat.Pdf, pdfFileName)
         ocrJobData.JobName = "MyJob"
         Dim ocrJob As IOcrAutoRecognizeJob = ocrAutoRecognizeManager.CreateJob(ocrJobData)

         ' Subscribe to the JobProgress event
         AddHandler ocrAutoRecognizeManager.JobProgress, AddressOf ocrAutoRecognizeManager_JobProgress

         ' Run the job
         ocrAutoRecognizeManager.RunJob(ocrJob)

         ' Unsubscribe to the JobProgress event
         RemoveHandler ocrAutoRecognizeManager.JobProgress, AddressOf ocrAutoRecognizeManager_JobProgress
      End Using
   End Sub

   Private Shared Sub ocrAutoRecognizeManager_JobProgress(ByVal sender As Object, ByVal e As OcrAutoRecognizeJobProgressEventArgs)
      Console.WriteLine(String.Format("Job: {0} - Page: {1}:{2} - {3} - {4}%", _
         e.Job.JobData.JobName, e.Data.CurrentPageIndex + 1, e.Data.LastPageIndex + 1, e.Data.Operation, e.Data.Percentage))
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

private static void JobProgressExample()
   {
      string tifFileName = Path.Combine(LEAD_VARS.ImagesDir,"Ocr1.tif");
      string pdfFileName = Path.Combine(LEAD_VARS.ImagesDir,"Ocr1.pdf");
      // Create an instance of the engine
      using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Professional, false))
      {
         // Start the engine using default parameters
         Console.WriteLine("Starting up the engine...");
         ocrEngine.Startup(null, null, null, null);

         IOcrAutoRecognizeManager ocrAutoRecognizeManager = ocrEngine.AutoRecognizeManager;

         // Run the job in 1 thread
         ocrAutoRecognizeManager.MaximumThreadsPerJob = 1;

         // Create the job
         OcrAutoRecognizeJobData ocrJobData = new OcrAutoRecognizeJobData(tifFileName, DocumentFormat.Pdf, pdfFileName);
         ocrJobData.JobName = "MyJob";
         IOcrAutoRecognizeJob ocrJob = ocrAutoRecognizeManager.CreateJob(ocrJobData);

         // Subscribe to the JobProgress event
         ocrAutoRecognizeManager.JobProgress += new EventHandler<OcrAutoRecognizeJobProgressEventArgs>(ocrAutoRecognizeManager_JobProgress);

         // Run the job
         ocrAutoRecognizeManager.RunJob(ocrJob);

         // Unsubscribe to the JobProgress event
         ocrAutoRecognizeManager.JobProgress -= new EventHandler<OcrAutoRecognizeJobProgressEventArgs>(ocrAutoRecognizeManager_JobProgress);
      }
   }

   private static void ocrAutoRecognizeManager_JobProgress(object sender, OcrAutoRecognizeJobProgressEventArgs e)
   {
      Console.WriteLine(string.Format("Job: {0} - Page: {1}:{2} - {3} - {4}%",
         e.Job.JobData.JobName, e.Data.CurrentPageIndex + 1, e.Data.LastPageIndex + 1, e.Data.Operation, e.Data.Percentage));
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IOcrAutoRecognizeManager Interface
IOcrAutoRecognizeManager Members
Programming with the LEADTOOLS .NET OCR