PDFOptimizer Class

class PDFOptimizer : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

Implementation of the PDF Optimizer function.

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

Uses types

CancelProc CompressImageType CompressQuality CompressionType Document ObjectCompressionType OptimizerOption ProgressMonitor

Constructor & Destructor Documentation

PDFOptimizer()

Construct a CPDFOptimizer, with default Options.

Property Documentation

short MajorVersion[get, set]

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

short MinorVersion[get, set]

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

ObjectCompressionType ObjectCompression[get, set]

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

Member Function Documentation

void Dispose()

Returns:

void

CompressQuality GetCompressionQuality(CompressImageType type)

Parameters

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

Returns:

CompressQuality

The compression quality level for the specified color model.

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

int GetMaxResolution(CompressImageType type)

Parameters

type: CompressImageType: 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.

bool GetOption(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.

CompressionType GetRecompressionType(CompressImageType type)

Parameters

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

Returns:

CompressionType

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 GetResampleToResolution(CompressImageType type)

Parameters

type: CompressImageType: 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.

void Optimize(Document doc, System.IO.Stream stream)

Parameters

doc: Document
stream: System.IO.Stream

Returns:

void

void Optimize(Document doc, System.IO.Stream stream, ProgressMonitor progressMonitor, CancelProc cancelProc)

Parameters

doc: Document
stream: System.IO.Stream
progressMonitor: ProgressMonitor
cancelProc: CancelProc

Returns:

void

void Optimize(Document document, string newPath)

Parameters

document: Document: The document to optimize.
newPath: string: The file system path where the optimized document will be saved.

Returns:

void

Perform the Optimization of a single document, saving the result in a new file.

void Optimize(Document document, string newPath, ProgressMonitor progressMonitor, CancelProc cancelProc)

Parameters

document: Document: The document to optimize.
newPath: string: The file system path where the optimized document will be saved.
progressMonitor: ProgressMonitor: An optional progress monitor callback, or NULL.
cancelProc: CancelProc: An optional cancellation callback, or NULL.

Returns:

void

Perform the Optimization of a single document, saving the result in a new file.

void SetCompressionQuality(CompressImageType type, CompressQuality value)

Parameters

type: CompressImageType: The image color type (Color, Gray, or BW) to set.
value: CompressQuality: 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 SetMaxResolution(CompressImageType type, int value)

Parameters

type: CompressImageType: 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 SetOption(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 SetRecompressionType(CompressImageType type, CompressionType value)

Parameters

type: CompressImageType: The image color type (Color, Gray, or BW) to set.
value: CompressionType: 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 SetResampleToResolution(CompressImageType type, int value)

Parameters

type: CompressImageType: 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.