In This Topic ▼

documentFormat Property

Summary

Output format to use for document conversion.

Syntax

TypeScript

JavaScript

Object.defineProperty(DocumentConverterJobData.prototype, 'documentFormat', 
   get: function(), 
   set: function(value) 
)

documentFormat: DocumentFormat;

Property Value

The output format to use for document conversion.

Remarks

Jobs can be converted using document or raster formats for the output. To convert to a document format (using LEADTOOLS Document Writer), set DocumentFormat to the desired DocumentFormat value and set RasterImageFormat to RasterImageFormat.Unknown.

To convert to a raster format (using LEADTOOLS Raster Codecs), set RasterImageFormat to the desired RasterImageFormat value and set DocumentFormat to DocumentFormat.User.

Therefore, one of DocumentFormat and RasterImageFormat is used during the conversion, otherwise, an exception will be thrown.

Use DocumentOptions to set the extra format options to use when converting to a document format.

Example

For an example, refer to Convert.

Requirements

Target Platforms