←Select platform

DocumentFormat Property

Summary

Output format to use for document conversion.

Syntax

Java

C++

public DocumentFormat DocumentFormat { get; set; }

Public Property DocumentFormat() As DocumentFormat 
   Get 
   Set

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

public DocumentFormat getDocumentFormat() 
public void setDocumentFormat(DocumentFormat 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 DocumentWriter), set DocumentFormat to the desired DocumentFormat value and set RasterImageFormat to RasterImageFormat.Unknown.

To convert to a raster format (using RasterCodecs), 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 DocumentConverter.DocumentWriterInstance to set the extra format options to use when converting to a document format.

Example

For an example, refer to RunJob and RunJobAsync.

Requirements

Help Version 19.0.2017.10.27

Leadtools.Documents.Converters Assembly