CreateJobData(LEADDocument,string,RasterImageFormat) Method

Summary

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

Syntax

C++

Java

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

Public Shared Function CreateJobData( 
   ByVal document As LEADDocument, 
   ByVal outputDocumentFileName As String, 
   ByVal rasterImageFormat As RasterImageFormat 
) As DocumentConverterJobData

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

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

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

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; 
 
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); 
            } 
         } 
      } 
   } 
}

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 DocumentConverterJobsCreateJobData4Example() 
   Using documentConverter As New DocumentConverter() 
      documentConverter.Diagnostics.EnableTrace = True 
 
      Dim inFile As String = Path.Combine(ImagesPath.Path, "Leadtools.docx") 
 
      Dim options As LoadDocumentOptions = New LoadDocumentOptions() 
      options.UseCache = False 
 
      Using document As LEADDocument = DocumentFactory.LoadFromFile(inFile, options) 
         Dim outFile As String = Path.Combine(ImagesPath.Path, "output.pdf") 
         Dim format As DocumentFormat = DocumentFormat.Pdf 
         Dim jobData As DocumentConverterJobData = DocumentConverterJobs.CreateJobData(document, 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 Using 
End Sub

Requirements

Target Platforms

Reference

DocumentConverterJobs Class

DocumentConverterJobs Members

Leadtools.Document.Converter Namespace

Using LEADTOOLS Document Converters

Download our FREE evaluation

Help Version 20.0.2020.3.31