SplitTIFFCompression

Sets the compression method used in the TIFF output by SplitMultipageTiff.

Member of namespace

Convert

Syntax

bool SplitTIFFCompression (int compressionTypeColor, int compressionTypeBW)

Parameters

compressionTypeColor
Type: int
compressionTypeBW
Type: int

Parameters

One of the following compression values are allowed.
  • 0 : Source Image compression.
  • 1 : No compression.
  • 2 : CCITT modified Huffman RLE. (BW 1 bit images only)
  • 3 : CCITT Group 3 T.4 fax. (BW 1 bit images only)
  • 4 : CCITT Group 4 T.6 fax. (BW 1 bit images only)
  • 5 : LZW Lempel-Ziv and Welch

Returns

True if the compression setting was successful.

False if the compression setting used is not a supported type.

Level

Page level.

Details

Sets the compression of the output image from SplitMultipageTiff. The action automatically detects the image bit depth (1 bit is a black and white image. Higher bit counts are treated as color.) of the image to split and uses the appropriate compressionTypeColor or compressionTypeBW setting when saving the individual images.

The parameters specified as "BW 1 bit images only" are compressions that only support black and white, 1 bit, color depths. The compression types that support only black and white cannot be specified in the "compressionTypeColor" parameter. If an incorrect compression value is specified, the value is not set and the action returns false.

If SplitTIFFCompression is not called before SplitMultipageTiff, the default value of CCITT4 (CITT Group 4 T.6) is used for black and white pages and the original source page image compression is used for color pages.

Example:
SplitTIFFCompression(5,4)
SplitMultipageTiff()

This example configures the SplitMultipageTiff action to use the LZW compression for color images and group 4 compression for black and white images. LZW is the best compression for color images because it is a loss-less compression that does not reduce the quality of the image.

See also

The ImageUtilities actions library contains actions that perform a variety of operations on images.