←Select platform

DocumentConverterJobs Class

Summary

Manages creating and running jobs in this document converter as well as job status events.

Syntax

Java

C++

public class DocumentConverterJobs

Public Class DocumentConverterJobs

public ref class DocumentConverterJobs

public class DocumentConverterJobs

Remarks

DocumentConverterJobs manages the creating and running jobs in this document converter as well as job status events and can be accessed through the Jobs property of DocumentConverter.

This class contains the following members:

Member	Description
CreateJob	Create a new job.
RunJob	Run a job.
RunJobAsync and AbortAllJobs	Run jobs in separate threads and support for aborting.
JobStarted, JobOperation and JobCompleted	Notification events for when a job starts, is in progress and when it is completed.
CreateJobData	Helper methods to quickly create a job from common input.

Example

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 DocumentConverterJobsExample() 
{ 
   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.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 
 
<TestMethod> 
Public Sub DocumentConverterJobsExample() 
   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