CreateJobData(string,string,DocumentFormat) Method

Summary

Fills in a common document conversion job data.

Syntax

C++

Java

public static DocumentConverterJobData CreateJobData( 
   string inputDocumentFileName, 
   string outputDocumentFileName, 
   DocumentFormat documentFormat 
)

Public Shared Function CreateJobData( 
   ByVal inputDocumentFileName As String, 
   ByVal outputDocumentFileName As String, 
   ByVal documentFormat As DocumentFormat 
) As DocumentConverterJobData

public:  
   static DocumentConverterJobData^ CreateJobData( 
      String^ inputDocumentFileName, 
      String^ outputDocumentFileName, 
      DocumentFormat^ documentFormat 
   )

public static DocumentConverterJobData createJobData(String inputDocumentFileName, String outputDocumentFileName, DocumentFormat documentFormat)

Parameters

inputDocumentFileName

Path to the input file for the conversion.

outputDocumentFileName

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

documentFormat

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 document conversion. The result DocumentConverterJobData will be initialized as follows:

Member	Description
InputDocumentFileName	inputDocumentFileName
OutputDocumentFileName	outputDocumentFileName
DocumentFormat	documentFormat

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

Member	Description
RasterImageFormat	RasterImageFormat instead.
Document	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

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 DocumentConverterJobsCreateJobData1Example() 
{ 
   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 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); 
         } 
      } 
   } 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Document.Writer 
Imports Leadtools.Svg 
Imports Leadtools.Document 
Imports Leadtools.Caching 
Imports Leadtools.Annotations.Engine 
Imports Leadtools.Ocr 
Imports Leadtools.Document.Converter 
Imports LeadtoolsDocumentConverterExamples.LeadtoolsExamples.Common 
 
Public Sub DocumentConverterJobsCreateJobData1Example() 
   Using documentConverter As New DocumentConverter() 
      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

Requirements

Target Platforms

Reference

DocumentConverterJobs Class

DocumentConverterJobs Members

Leadtools.Document.Converter Namespace

Using LEADTOOLS Document Converter

Download our FREE evaluation

Help Version 21.0.2021.6.30

Leadtools.Document.Converter Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Converter Namespace

Assemblies