←Select platform

CreateJobData(Document,string,DocumentFormat) Method

Summary

Fills in a common document conversion job data for an input Document.

Syntax

C#
VB
Java
C++
Public Shared Function CreateJobData( 
   ByVal document As Document, 
   ByVal outputDocumentFileName As String, 
   ByVal documentFormat As DocumentFormat 
) As DocumentConverterJobData 
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.

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
Document document
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.
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

C#
VB
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 DocumentConverterJobsCreateJobData3Example() 
{ 
   using (DocumentConverter documentConverter = new DocumentConverter()) 
   { 
      var inFile = Path.Combine(ImagesPath.Path, @"Leadtools.doc"); 
      var outFile = Path.Combine(ImagesPath.Path, @"output.tif"); 
      var format = RasterImageFormat.Tif; 
      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.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 DocumentConverterJobsCreateJobData3Example() 
   Using documentConverter As New DocumentConverter() 
      Dim inFile As String = Path.Combine(ImagesPath.Path, "Leadtools.docx") 
      Dim outFile As String = Path.Combine(ImagesPath.Path, "output.tif") 
      Dim format As RasterImageFormat = RasterImageFormat.Tif 
      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

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Documents.Converters Assembly