←Select platform

DocumentConverterOptions Class

Summary

Manages the extra options to use with the document converter.

Syntax

Java

C++

public class DocumentConverterOptions

Public Class DocumentConverterOptions

public ref class DocumentConverterOptions

public class DocumentConverterOptions

Remarks

DocumentConverterOptions manages the extra options to use with the document converter and can be accessed through the Options property of DocumentConverter.

This class contains the following members:

Member	Description
JobErrorMode	Ability to resume on none critical errors.
PageNumberingTemplate	Template to use for the individual file names when the output format does not support multi-pages.
OutputSinglePages	Force outputting single page files even if the format supports multi-page. For raster conversion only.
EnableSvgConversion	Use SVG conversion when supported.
SvgImagesRecognitionMode	Determines how to treat any image elements encountered in an input SVG page during the conversion.
EmptyPageMode	Determines how empty pages are treated during the conversion.
UseThreads	Indicates whether to use multiple threads during the conversion.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.DocumentWriters; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
using Leadtools.Documents; 
using Leadtools.Caching; 
using Leadtools.Annotations.Core; 
using Leadtools.Forms.Ocr; 
using Leadtools.Documents.Converters; 
 
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.Advantage, false); 
      var rasterCodecs = new RasterCodecs(); 
      var documentWriter = new DocumentWriter(); 
      ocrEngine.Startup(rasterCodecs, documentWriter, null, LEAD_VARS.OcrAdvantageRuntimeDir); 
      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 OcrAdvantageRuntimeDir = @"C:\LEADTOOLS 19\Bin\Common\OcrAdvantageRuntime"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Forms.DocumentWriters 
Imports Leadtools.Svg 
Imports Leadtools.Documents 
Imports Leadtools.Caching 
Imports Leadtools.Annotations.Core 
Imports Leadtools.Forms.Ocr 
Imports Leadtools.Documents.Converters 
Imports LeadtoolsDocumentsConvertersExamples.LeadtoolsExamples.Common 
 
Public Sub DocumentConverterOptionsExample() 
   Using documentConverter As 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 
 
      Dim ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Advantage, False) 
      Dim rasterCodecs As RasterCodecs = New RasterCodecs() 
      Dim documentWriter As DocumentWriter = New DocumentWriter() 
      ocrEngine.Startup(rasterCodecs, documentWriter, Nothing, LEAD_VARS.OcrAdvantageRuntimeDir) 
      documentConverter.SetOcrEngineInstance(ocrEngine, True) 
      documentConverter.Diagnostics.EnableTrace = True 
 
      Dim inFile As String = Path.Combine(ImagesPath.Path, "Leadtools.docx") 
      Dim outFile As String = Path.Combine(ImagesPath.Path, "output.pdf") 
      Dim format As DocumentFormat = DocumentFormat.Pdf 
      Dim jobData As DocumentConverterJobData = DocumentConverterJobs.CreateJobData(inFile, outFile, format) 
      jobData.JobName = "conversion job" 
 
      Dim job As DocumentConverterJob = documentConverter.Jobs.CreateJob(jobData) 
      documentConverter.Jobs.RunJob(job) 
 
      If job.Status = DocumentConverterJobStatus.Success Then 
         Console.WriteLine("Success") 
      Else 
         Console.WriteLine("{0} Errors", job.Status) 
         For Each errorItem As DocumentConverterJobError In job.Errors 
            Console.WriteLine("  {0} at {1}: {2}", errorItem.Operation, errorItem.InputDocumentPageNumber, errorItem.Error.Message) 
         Next 
      End If 
   End Using 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const OcrAdvantageRuntimeDir As String = "C:\LEADTOOLS 19\Bin\Common\OcrAdvantageRuntime" 
End Class

Requirements

Target Platforms

Reference

DocumentConverterOptions Members

Leadtools.Documents.Converters Namespace

Using LEADTOOLS Document Converters

Programming with the LEADTOOLS .NET OCR

Help Version 19.0.2017.10.27

Leadtools.Documents.Converters Assembly

Introduction

Getting Started

Namespaces

Leadtools.Documents.Converters Namespace

Assemblies