PDFOptimizer Class

class PDFOptimizer

Namespace:datalogics_interface

Detailed Description

Implementation of the PDF Optimizer function.

Use the PDFOptimizer object to accumulate options for the Optimization, and to Optimize documents.

Uses types

OptimizerCompressQuality OptimizerCompressionType OptimizerImageType OptimizerObjectCompression OptimizerOption

Constructor & Destructor Documentation

PDFOptimizer()

Construct a CPDFOptimizer, with default Options.

PDFOptimizer(PDFOptimizer && )

Parameters

: PDFOptimizer &&

~PDFOptimizer()

Member Function Documentation

OptimizerCompressQuality get_compression_quality(OptimizerImageType type)

Parameters

type: OptimizerImageType: The image color type (Color, Gray, or BW) to query.

Returns:

OptimizerCompressQuality

The compression quality level for the specified color model.

Get the value of the Compression Quality for a given color model.

int get_major_version()

Returns:

int

The major PDF version number, or 0 if the Optimizer will decide.

Get the value of the Major Version of the optimized document.

NOTE: A value of 0 indicates the Optimizer will decide what version it should be.

int get_max_resolution(OptimizerImageType type)

Parameters

type: OptimizerImageType: The image color type (Color, Gray, or BW) to query.

Returns:

int

The maximum resolution in DPI above which images will be downsampled.

Get the value of the Max DPI for a given color model.

int get_minor_version()

Returns:

int

The minor PDF version number.

Get the value of the Minor Version of the optimized document.

OptimizerObjectCompression get_object_compression()

Returns:

OptimizerObjectCompression

The current object compression type setting.

Get the value of the Object Compression of the optimized document.

bool get_option(OptimizerOption option)

Parameters

option: OptimizerOption: The optimization option to query.

Returns:

bool

true if the option is enabled, false if it is disabled.

Get the value of a single Optimizer Option.

OptimizerCompressionType get_recompression_type(OptimizerImageType type)

Parameters

type: OptimizerImageType: The image color type (Color, Gray, or BW) to query.

Returns:

OptimizerCompressionType

The compression type that will be applied to images of the specified color model.

Get the value of the Recompression Type for a given color model.

int get_resample_to_resolution(OptimizerImageType type)

Parameters

type: OptimizerImageType: The image color type (Color, Gray, or BW) to query.

Returns:

int

The target resolution in DPI to which images will be downsampled.

Get the value of the Resample To DPI for a given color model.

PDFOptimizer & operator=(PDFOptimizer && )

Parameters

: PDFOptimizer &&

Returns:

PDFOptimizer &

void optimize(Document & document, const std::string & output_path)

Parameters

document: Document &: The document to optimize.
output_path: const std::string &: The file system path where the optimized document will be saved.

Returns:

void

Optimize a document and save to a new file path. Perform the Optimization of a single document, saving the result in a new file.

void set_compression_quality(OptimizerImageType type, OptimizerCompressQuality value)

Parameters

type: OptimizerImageType: The image color type (Color, Gray, or BW) to set.
value: OptimizerCompressQuality: The compression quality level to apply.

Returns:

void

Set the value for the Compression Quality for a given color model. Any image that recompressed, regardless of the reason, will use this Quality for the Quality value of the specific compression type.

void set_major_version(int major)

Parameters

major: int: The major PDF version number.

Returns:

void

Set the value for the Major Version for the optimized document.

void set_max_resolution(OptimizerImageType type, int value)

Parameters

type: OptimizerImageType: The image color type (Color, Gray, or BW) to set.
value: int: The maximum resolution in DPI.

Returns:

void

Set the value for the Max DPI for a given color model. Any image above this resolution will be down sampled, if the Downsampling option is true for this color model.

void set_minor_version(int minor)

Parameters

minor: int: The minor PDF version number.

Returns:

void

Set the value for the Minor Version for the optimized document.

void set_object_compression(OptimizerObjectCompression type)

Parameters

type: OptimizerObjectCompression: The desired object compression type.

Returns:

void

Set the value for the Object Compression for the optimized document.

void set_option(OptimizerOption option, bool value)

Parameters

option: OptimizerOption: The optimization option to set.
value: bool: true to enable the option, false to disable it.

Returns:

void

Set the value of a single Optimizer option.

void set_recompression_type(OptimizerImageType type, OptimizerCompressionType value)

Parameters

type: OptimizerImageType: The image color type (Color, Gray, or BW) to set.
value: OptimizerCompressionType: The compression type to apply.

Returns:

void

Set the value for the recompression Type for a given color model. Any image that is downsampled will be compressed using this method, if the Downsampling option is true for this color model. Any image that is not downsampled, will be converted to this compression type, if it is not already compressed in this type, and the Recompression option for this color model is true.

void set_resample_to_resolution(OptimizerImageType type, int value)

Parameters

type: OptimizerImageType: The image color type (Color, Gray, or BW) to set.
value: int: The target resolution in DPI.

Returns:

void

Set the value for the Resample To DPI for a given color model. Any image will be downsampled to this resolution, if the Downsampling option is true for this color model.