PDFOptimizer Class

classPDFOptimizer : 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.

Referenced by

PDFOptimizer

Uses types

CancelProc CompressImageType CompressQuality CompressionType Document ObjectCompressionType OptimizerOption PDFOptimizer ProgressMonitor

Constructor & Destructor Documentation

PDFOptimizer(PDFOptimizerrhs, InternalConstructsignifier)

Parameters

rhs: PDFOptimizer
signifier: InternalConstruct

PDFOptimizer()

Construct a CPDFOptimizer, with default Options.

~PDFOptimizer()

Property Documentation

shortMajorVersion[get, set]

shortMinorVersion[get, set]

ObjectCompressionTypeObjectCompression[get, set]

Member Function Documentation

static PDFOptimizerConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

PDFOptimizer

voidDispose()

Returns:

void

voidDisposeChildren()

Returns:

void

CompressQualityGetCompressionQuality(CompressImageTypetype)

Parameters

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

Returns:

The compression quality level for the specified color model.

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

intGetMaxResolution(CompressImageTypetype)

Parameters

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

Returns:

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

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

boolGetOption(OptimizerOptionoption)

Parameters

option: OptimizerOption: The optimization option to query.

Returns:

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

Get the value of a single Optimizer Option.

CompressionTypeGetRecompressionType(CompressImageTypetype)

Parameters

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

Returns:

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.

intGetResampleToResolution(CompressImageTypetype)

Parameters

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

Returns:

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

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

voidOptimize(Documentdocument, CDotNetStreamFiledest)

Parameters

document: Document: The document to optimize.
dest: CDotNetStreamFile: The stream file handle to write the optimized document to.

Returns:

void

Perform the Optimization of a single document, saving the result to a stream.

voidOptimize(Documentdocument, CDotNetStreamFiledest, ProgressMonitorprogressMonitor, CancelProccancelProc)

Parameters

document: Document: The document to optimize.
dest: CDotNetStreamFile: The stream file handle to write the optimized document to.
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 to a stream.

voidOptimize(Documentdoc, System.IO.Streamstream)

Parameters

doc: Document
stream: System.IO.Stream

Returns:

void

voidOptimize(Documentdoc, System.IO.Streamstream, ProgressMonitorprogressMonitor, CancelProccancelProc)

Parameters

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

Returns:

void

voidOptimize(Documentdocument, stringnewPath)

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.

voidOptimize(Documentdocument, stringnewPath, ProgressMonitorprogressMonitor, CancelProccancelProc)

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.

voidSetCompressionQuality(CompressImageTypetype, CompressQualityvalue)

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.

voidSetMaxResolution(CompressImageTypetype, intvalue)

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.

voidSetOption(OptimizerOptionoption, boolvalue)

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.

voidSetRecompressionType(CompressImageTypetype, CompressionTypevalue)

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.

voidSetResampleToResolution(CompressImageTypetype, intvalue)

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.