CreateJobData(LEADDocument,string,RasterImageFormat) Method

Summary

Fills in a common raster conversion job data for an input LEADDocument.

Syntax

C++/CLI

Java

Python

public static DocumentConverterJobData CreateJobData( 
   LEADDocument document, 
   string outputDocumentFileName, 
   RasterImageFormat rasterImageFormat 
)

public:  
   static DocumentConverterJobData^ CreateJobData( 
      LEADDocument^ document, 
      String^ outputDocumentFileName, 
      RasterImageFormat^ rasterImageFormat 
   )

public static DocumentConverterJobData createJobData(Document document, String outputDocumentFileName, DocumentFormat documentFormat)

def CreateJobData(self,document,outputDocumentFileName,rasterImageFormat):

Parameters

document

Input document to convert.

outputDocumentFileName

Path to the output file to be generated by this conversion.

rasterImageFormat

The output format.

Return Value

The newly initialized job data.

Remarks

This method fills in the necessary members required for a job data to be used in a raster conversion. The result DocumentConverterJobData will be initialized as follows:

Member	Description
Document	document
OutputDocumentFileName	outputDocumentFileName
RasterImageFormat	rasterImageFormat

The rest of the members are initialized to the following default values to mark them as "unused"

Member	Description
DocumentFormat	DocumentFormat instead.
InputDocumentFileName	null
InputAnnotationsFileName	null
InputDocumentFirstPageNumber	1 (first page)
InputDocumentLastPageNumber	-1 (last page)
RasterImageBitsPerPixel	0 (default)
OutputAnnotationsFileName	null
JobName	null
UserData	null
AnnotationsMode	DocumentConverterAnnotationsMode.None

You can modify the values of DocumentConverterJobData such as JobName and UserData on the returned object before passing it to CreateJob.

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 DocumentConverterJobsCreateJobData4Example() 
{ 
   using (DocumentConverter documentConverter = new DocumentConverter()) 
   { 
      documentConverter.Diagnostics.EnableTrace = true; 
 
      var inFile = Path.Combine(ImagesPath.Path, @"Leadtools.doc"); 
 
      var options = new LoadDocumentOptions(); 
      options.UseCache = false; 
 
      using (var document = DocumentFactory.LoadFromFile(inFile, options)) 
      { 
         var outFile = Path.Combine(ImagesPath.Path, @"output.pdf"); 
         var format = DocumentFormat.Pdf; 
         var jobData = DocumentConverterJobs.CreateJobData(document, 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); 
            } 
         } 
      } 
   } 
}

 
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 documentConverterJobsCreateJobData4Example() { 
   String LEAD_VARS_ImagesDir = "C:\\LEADTOOLS23\\Resources\\Images"; 
   DocumentConverter documentConverter = new DocumentConverter(); 
   documentConverter.getDiagnostics().setEnableTrace(true); 
 
   String inFile = combine(LEAD_VARS_ImagesDir, "Leadtools.pdf"); 
   LoadDocumentOptions options = new LoadDocumentOptions(); 
   options.setUseCache(true); 
 
   LEADDocument document = DocumentFactory.loadFromFile(inFile, options); 
   String outFile = combine(LEAD_VARS_ImagesDir, "output.docx"); 
   DocumentFormat format = DocumentFormat.DOCX; 
   DocumentConverterJobData jobData = DocumentConverterJobs.createJobData(document, outFile, format); 
   jobData.setJobName("Conversion Job"); 
   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

DocumentConverterJobs Class

DocumentConverterJobs 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