Status Property

Summary

Current status of the job and allows the user to cancel it.

Syntax

C++/CLI

Java

Python

public DocumentConverterJobStatus Status { get; set; }

public:  
   property DocumentConverterJobStatus^ Status 
   { 
      DocumentConverterJobStatus^ get() 
      void set(DocumentConverterJobStatus^ value) 
   }

public DocumentConverterJobStatus getStatus() 
public void setStatus(DocumentConverterJobStatus value)

Status # get and set (DocumentConverterJobEventArgs)

Property Value

The current status of the job and allows the user to cancel it.

Remarks

Set Status to DocumentConverterJobStatus.Abort to abort this job.

Example

Java

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 DocumentConverterJobsRunJobAsyncExample() 
{ 
   using (DocumentConverter documentConverter = new DocumentConverter()) 
   { 
      documentConverter.Diagnostics.EnableTrace = true; 
 
      var inFile = Path.Combine(ImagesPath.Path, @"Leadtools.doc"); 
      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); 
 
      AutoResetEvent finished = null; 
 
      EventHandler<DocumentConverterJobEventArgs> completed = null; 
      completed = (sender, e) => 
      { 
         if (e.Status == DocumentConverterJobStatus.Success) 
         { 
            Console.WriteLine("Success"); 
         } 
         else 
         { 
            Console.WriteLine("{0} Errors", e.Status); 
            foreach (var error in e.Job.Errors) 
            { 
               Console.WriteLine("  {0} at {1}: {2}", error.Operation, error.InputDocumentPageNumber, error.Error.Message); 
            } 
         } 
 
         var thisJobs = sender as DocumentConverterJobs; 
         thisJobs.JobCompleted -= completed; 
 
         finished.Set(); 
      }; 
 
      documentConverter.Jobs.JobCompleted += completed; 
 
      finished = new AutoResetEvent(false); 
      documentConverter.Jobs.RunJobAsync(job); 
      finished.WaitOne(); 
   } 
}

 
import static org.junit.Assert.assertTrue; 
 
import java.io.File; 
import java.io.FileOutputStream; 
import java.io.IOException; 
import java.net.URI; 
import java.util.concurrent.Executors; 
import java.util.logging.ConsoleHandler; 
import java.util.logging.Handler; 
import java.util.logging.Level; 
import java.util.logging.Logger; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
 
import leadtools.*; 
import leadtools.annotations.rendering.AnnJavaRenderingEngine; 
import leadtools.caching.FileCache; 
import leadtools.codecs.*; 
import leadtools.document.DocumentFactory; 
import leadtools.document.DownloadDocumentOptions; 
import leadtools.document.LEADDocument; 
import leadtools.document.LoadDocumentOptions; 
import leadtools.document.LoadFromCacheOptions; 
import leadtools.document.UploadDocumentOptions; 
import leadtools.document.converter.DocumentConverter; 
import leadtools.document.converter.DocumentConverterEmptyPageMode; 
import leadtools.document.converter.DocumentConverterJob; 
import leadtools.document.converter.DocumentConverterJobData; 
import leadtools.document.converter.DocumentConverterJobError; 
import leadtools.document.converter.DocumentConverterJobErrorMode; 
import leadtools.document.converter.DocumentConverterJobStatus; 
import leadtools.document.converter.DocumentConverterJobs; 
import leadtools.document.writer.DocumentFormat; 
import leadtools.document.writer.DocumentWriter; 
import leadtools.ocr.OcrEngine; 
import leadtools.ocr.OcrEngineManager; 
import leadtools.ocr.OcrEngineType; 
 
 
public void documentConverterJobsRunJobAsyncExample() { 
   // ASYNC IS NOT IN JAVA 
}

Requirements

Target Platforms

Reference

DocumentConverterJobEventArgs Class

DocumentConverterJobEventArgs Members

Leadtools.Document.Converter Namespace

Using LEADTOOLS Document Converter

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document.Converter Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Converter Namespace

Assemblies