PDF to Image Converter | X4Documentation

This adapter converts and scales the first page of an existing, unprotected PDF document into an image format.

The following formats can be created: BMP, GIF, JPEG, JPEG 2000, PNG, PNM and TIFF. The adapter outputs the graphic in the desired file format as a binary data stream.

Properties

Operation

Determines which operation the adapter executes

Possible values: Transform: Convert PDF to image format

Parameters

Adapter	Main class of the adapter (do not change!) Possible values: `en.softproject.integration.adapter.pdf.PDF2Image`: Main class (default)
width	Width of the output image in pixels (ignored if parameter maxSize is set) Possible values: Any positive integer, e.g. `800` `-1` (in combination with a positive pixel number in parameter height): retain the original aspect ratio when scaling the image; in combination with the value -1 in parameter height the original image dimensions are retained
height	Height of the output image in pixels (ignored if parameter maxSize is set) Possible values: Any positive integer, e.g. `600` `-1` (in combination with a positive pixel number in parameter `width`): retain the original aspect ratio when scaling the image; in combination with the value `-1` in parameter `width` the original image dimensions are retained
page	Page within the PDF document that is to be output as an image. Possible values: Any integer
maxSize	Maximum width or height of the output image in pixels (parameters `width` and `height` are ignored). Possible values: Any integer `0`: Use `width` and `height` parameters for scaling (default)
scaleAlgorithm	Scaling algorithm used Possible values: `SCALE_DEFAULT`: Use standard algorithm `SCALE_FAST`: Use fast algorithm `SCALE_SMOOTH`: Use edge smoothing algorithm `SCALE_REPLICATE`: Use pixel repetition algorithm `SCALE_AREA-AVERAGING`: Use area averaging algorithm
outputFormat	Output image format Possible values: `BMP`: Create Windows Bitmap Graphic `GIF`: Create GIF compressed image `JPEG`: Create JPEG-compressed image `JPEG 2000:` Create image in JPEG 2000 format `PNG`: Create PNG image `PNM`: Create image in Portable Anymap format `TIFF`: Create image in Tagged Image File Format

Status values

`1`	The operation was executed successfully.
`-1`	The operation failed due to a technical error.