←Select platform

Is this page helpful?

In this page

JobErrorMode Property

Summary

Indicates whether to abort or try to continue running jobs when an error occurs.

Syntax
C#
C++/CLI
Java
Python
public DocumentConverterJobErrorMode JobErrorMode { get; set; } 
public:  
   property DocumentConverterJobErrorMode^ JobErrorMode 
   { 
      DocumentConverterJobErrorMode^ get() 
      void set(DocumentConverterJobErrorMode^ value) 
   } 
public DocumentConverterJobErrorMode getJobErrorMode() 
public void setJobErrorMode(DocumentConverterJobErrorMode value) 
JobErrorMode # get and set (DocumentConverterOptions) 

Property Value

An DocumentConverterJobErrorMode enumeration member that specifies whether to abort or try to continue running jobs when an error occur. Default value is DocumentConverterJobErrorMode.Continue.

Remarks

When the value of this property is DocumentConverterJobErrorMode.Abort, any error that may occur while running a job will result in an exception being thrown.

If the value of this property is DocumentConverterJobErrorMode.Continue, then none critical errors can be logged and running continues. For example, if a source document has a page that could not be recognized. The offending page will be added to the final document as a graphics images and recognition will continue to the next page. In this mode, the engine will not throw an exception if an error occur, instead, all errors will be logged into the job's DocumentConverterJob.Errors collection. When conversion finishes, you can check if this collection is not empty and get the information of the errors and act upon them according to your application logic.

Refer to DocumentConverterJobOperation for information on which operation is considered critical.

Example
C#
Copied to clipboard
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
using Leadtools.Document; 
using Leadtools.Caching; 
using Leadtools.Annotations.Engine; 
using Leadtools.Ocr; 
using Leadtools.Document.Converter; 
using Leadtools.Annotations.Rendering; 
 
public void DocumentConverterOptionsExample() 
{ 
   using (DocumentConverter documentConverter = new DocumentConverter()) 
   { 
      //use options to force ocr conversion (disable SVG) 
      documentConverter.Options.EnableSvgConversion = false; 
      //abort job at first error (in any page) 
      documentConverter.Options.JobErrorMode = DocumentConverterJobErrorMode.Abort; 
 
      var ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD); 
      var rasterCodecs = new RasterCodecs(); 
      var documentWriter = new DocumentWriter(); 
      ocrEngine.Startup(rasterCodecs, documentWriter, null, LEAD_VARS.OcrLEADRuntimeDir); 
      documentConverter.SetOcrEngineInstance(ocrEngine, true); 
      documentConverter.Diagnostics.EnableTrace = true; 
 
      var inFile = Path.Combine(ImagesPath.Path, @"Leadtools.docx"); 
      var outFile = Path.Combine(ImagesPath.Path, @"output.pdf"); 
      var format = DocumentFormat.Pdf; 
      var jobData = DocumentConverterJobs.CreateJobData(inFile, outFile, format); 
      jobData.JobName = "conversion job"; 
 
      var job = documentConverter.Jobs.CreateJob(jobData); 
      documentConverter.Jobs.RunJob(job); 
 
      if (job.Status == DocumentConverterJobStatus.Success) 
      { 
         Console.WriteLine("Success"); 
      } 
      else 
      { 
         Console.WriteLine("{0} Errors", job.Status); 
         foreach (var error in job.Errors) 
         { 
            Console.WriteLine("  {0} at {1}: {2}", error.Operation, error.InputDocumentPageNumber, error.Error.Message); 
         } 
      } 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS22\Bin\Common\OcrLEADRuntime"; 
} 
Requirements

Target Platforms

Help Version 22.0.2023.5.10
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Converter Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.