CreateJobData(String,String,RasterImageFormat) Method

C#
Visual Basic
Objective-C
Java
C++

public static DocumentConverterJobData CreateJobData( 
   string inputDocumentFileName,
   string outputDocumentFileName,
   RasterImageFormat rasterImageFormat
)

'Declaration

Public Overloads Shared Function CreateJobData( _
   ByVal inputDocumentFileName As String, _
   ByVal outputDocumentFileName As String, _
   ByVal rasterImageFormat As RasterImageFormat _
) As DocumentConverterJobData

'Usage

Dim inputDocumentFileName As String
Dim outputDocumentFileName As String
Dim rasterImageFormat As RasterImageFormat
Dim value As DocumentConverterJobData
 
value = DocumentConverterJobs.CreateJobData(inputDocumentFileName, outputDocumentFileName, rasterImageFormat)

public static DocumentConverterJobData createJobData(String inputDocumentFileName, String outputDocumentFileName, RasterImageFormat rasterImageFormat)

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

Parameters

inputDocumentFileName: Path to the input file for the conversion.
outputDocumentFileName: Path to the output file to be generated by this conversion.
rasterImageFormat: The output format.

Return Value

The newly initialized job data.

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
InputDocumentFileName	inputDocumentFileName
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.User. Use 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.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

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

<TestMethod> _
Public Sub DocumentConverterJobsCreateJobData2Example()
   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

using Leadtools;
using Leadtools.Codecs;
using Leadtools.Forms.DocumentWriters;
using Leadtools.Svg;
using Leadtools.Documents;
using Leadtools.Caching;
using Leadtools.Annotations.Core;
using Leadtools.Forms.Ocr;
using Leadtools.Documents.Converters;

[TestMethod]
public void DocumentConverterJobsCreateJobData2Example()
{
   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);
         }
      }
   }
}

Target Platforms

Reference

DocumentConverterJobs Class
DocumentConverterJobs Members
Overload List
Using LEADTOOLS Document Converters