←Select platform

DocumentConverterJob Class

Summary

Document converter job.

Syntax

Java

C++

public class DocumentConverterJob

Public Class DocumentConverterJob

public ref class DocumentConverterJob

public class DocumentConverterJob

Remarks

To run a job with DocumentConverter, first initialize a new DocumentConverterJobData object with the job's parameters (input document or file name, pages, output format, output file name, options annotations, etc.), then use CreateJob object. Finally pass this job to either DocumentConverterJobs.RunJob or DocumentConverterJobs.RunJobAsync.

The job instance can also be tracked and obtained through the DocumentConverterJobs.JobStarted, DocumentConverterJobs.JobOperation and DocumentConverterJobs.JobCompleted, events through the event data (DocumentConverterJobEventArgs.Job).

Status will contain the final status of the job when it finishes running. If the value is not DocumentConverterJobStatus.Success, then errors might have occurred and these errors are added to the Errors list.

When the job finishes, the ConversionModes property will contain the modes used during this job processing and the value of OutputFiles will contain a list of all the output files generated during the conversion.

Example

For an example, refer to RunJob and RunJobAsync.

Requirements

Target Platforms