SetDocumentWriterInstance Method

Summary

Sets the document writer instance to use when converting documents.

Syntax

C++/CLI

Java

Python

public void SetDocumentWriterInstance( 
   DocumentWriter instance 
)

public:  
   void SetDocumentWriterInstance( 
      DocumentWriter^ instance 
   )

public void setDocumentWriterInstance(DocumentWriter instance)

def SetDocumentWriterInstance(self,instance):

Parameters

instance

The document writer instance to use when converting documents.

Remarks

The DocumentWriter instance passed to this method will be used when the DocumentConverter is in document conversion mode to create the output file. This DocumentConverter does not create its own DocumentWriter and will throw an error if the user instruct it to run with document output without a previously set instance.

DocumentWriterInstance will return the same value passed for instance.

The previously set IOcrEngine is removed when a new instance is set. You can set a value of null.

The document writer will use the options set in this DocumentWriter when saving documents. Refer to DocumentOptions for more information.

Example

Java

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 DocumentConverterExample() 
{ 
   using (DocumentConverter documentConverter = new DocumentConverter()) 
   { 
      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 documentWriter = new DocumentWriter(); 
      documentConverter.SetDocumentWriterInstance(documentWriter); 
 
      var renderingEngine = new AnnWinFormsRenderingEngine(); 
      documentConverter.SetAnnRenderingEngineInstance(renderingEngine); 
 
      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); 
         } 
      } 
   } 
}

 
import static org.junit.Assert.assertTrue; 
 
import java.io.File; 
import java.io.FileOutputStream; 
import java.io.IOException; 
import java.net.URI; 
import java.util.concurrent.Executors; 
import java.util.logging.ConsoleHandler; 
import java.util.logging.Handler; 
import java.util.logging.Level; 
import java.util.logging.Logger; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
 
import leadtools.*; 
import leadtools.annotations.rendering.AnnJavaRenderingEngine; 
import leadtools.caching.FileCache; 
import leadtools.codecs.*; 
import leadtools.document.DocumentFactory; 
import leadtools.document.DownloadDocumentOptions; 
import leadtools.document.LEADDocument; 
import leadtools.document.LoadDocumentOptions; 
import leadtools.document.LoadFromCacheOptions; 
import leadtools.document.UploadDocumentOptions; 
import leadtools.document.converter.DocumentConverter; 
import leadtools.document.converter.DocumentConverterEmptyPageMode; 
import leadtools.document.converter.DocumentConverterJob; 
import leadtools.document.converter.DocumentConverterJobData; 
import leadtools.document.converter.DocumentConverterJobError; 
import leadtools.document.converter.DocumentConverterJobErrorMode; 
import leadtools.document.converter.DocumentConverterJobStatus; 
import leadtools.document.converter.DocumentConverterJobs; 
import leadtools.document.writer.DocumentFormat; 
import leadtools.document.writer.DocumentWriter; 
import leadtools.ocr.OcrEngine; 
import leadtools.ocr.OcrEngineManager; 
import leadtools.ocr.OcrEngineType; 
 
 
public void documentConverterExample() { 
 
   String LEAD_VARS_ImagesDir = "C:\\LEADTOOLS23\\Resources\\Images"; 
   DocumentConverter documentConverter = new DocumentConverter(); 
   String inFile = combine(LEAD_VARS_ImagesDir, "Leadtools.pdf"); 
   String outFile = combine(LEAD_VARS_ImagesDir, "output.docx"); 
   DocumentFormat format = DocumentFormat.DOCX; 
   DocumentConverterJobData jobData = DocumentConverterJobs.createJobData(inFile, outFile, format); 
   jobData.setJobName("Conversion Job"); 
 
   documentConverter.setDocumentWriterInstance(new DocumentWriter()); 
   documentConverter.setAnnRenderingEngineInstance(new AnnJavaRenderingEngine()); 
   RasterDefaults.setExecutorService(Executors.newFixedThreadPool(5)); 
 
   DocumentConverterJob job = documentConverter.getJobs().createJob(jobData); 
   documentConverter.getJobs().runJob(job); 
   assertTrue(job.getStatus() == DocumentConverterJobStatus.SUCCESS); 
   if (job.getStatus() == DocumentConverterJobStatus.SUCCESS) { 
      System.out.println("Success!"); 
   } else { 
      for (DocumentConverterJobError error : job.getErrors()) { 
         System.out.println(error.getError().toString()); 
      } 
   } 
}

Requirements

Target Platforms

Reference

DocumentConverter Class

DocumentConverter Members

Leadtools.Document.Converter Namespace

Using LEADTOOLS Document Converter

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document.Converter Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Converter Namespace

Assemblies