ToImageOptionsSpec

A complex data type that you can use as the value for the Convert Image Options property of the toImage operation(deprecated) and toImage operation operations that the Convert PDF service provides.

The information that this variable holds specifies properties of the image files that the toImage operation generates, such as the type of image compression, color format, and resolution.

For information about data that can be accessed using Xpath Expressions, see Data items.

Data items

The data items that ToImageOptionsSpec variables contain.

cmykPolicy

A string value that represents the CMYK policy. This option is valid for conversions to JPEG, JP2K, and TIFF image formats. These values are valid:

  • embedProfile

  • off

colorCompression

A string value that represents the color compression to use. This option is valid for conversion to JPEG, JP2K, and TIFF formats. These values are valid:

  • minimum

  • low

  • medium

  • high

  • maximum

  • lossless

  • lzw

  • zip

  • none

colorSpace

A string value that represents the color space. These values are valid:

  • rgb

  • cmyk

  • grayscale

filter

A string value that represents the filter. This option is valid for conversion to PNG format only. These values are valid:

  • none

  • sub

  • up

  • average

  • path

  • adaptive

format

A string value that represents the JPEG format. This option is valid for conversion to JPEG and JP2K formats. These values are valid:

  • standard

  • optimized

  • 3scans

  • 4scans

  • 5scans

grayScaleCompression

A string value that represents the grayscale compression. This option is valid for conversion to JPEG, JP2K, and TIFF formats. These values are valid:

  • minimum

  • low

  • medium

  • high

  • maximum

  • lossless

  • lzw

  • zip

  • none

grayScalePolicy

A string value that represents the grayscale policy. This option is valid for conversion to JPEG, JP2K, and TIFF formats. These values are valid:

  • embedProfile

  • off

imageConvertFormat

A string value that represents the image conversion format. This property must be set. These values are valid:

  • jpeg

  • jp2k

  • png

  • tiff

interlace

A string value that represents the interlace. This option is valid for conversion to PNG format only. These values are valid:

  • none

  • adam7

monochrome

A string value that represents the monochrome compression. This option is valid for conversion to TIFF format only. These values are valid:

  • none

  • ccittg3

  • ccittg4

  • lzw

  • zip

options

A string value that represents the options that are set.

resolution

A string value that represents the image resolution. These values are valid:

  • 72

  • 96

  • 150

  • 300

  • 600

  • 1200

  • 2400

rgbPolicy

A string value that represents the RGB policy. These values are valid:

  • embedProfile

  • off

rowsPerStrip

An int value that represents the number of rows of pixels per strip to use for encoding the TIFF image. A value of 0 sets the rows per strip equal to the image length, resulting in a single strip. A value of -1 (the default value) sets the rows per strip equal to infinity, resulting in a single strip.

This value is only used when the imageConvertFormat property is set to tiff.

tileSize

An int value that represents the image tile size. This option is valid for conversion to JP2K format only. The value must be within the range 128-2048, inclusive.