Show / Hide Table of Contents

Class Optimizer.ImageSettings

A class that stores downsampling/recompression settings for color and grayscale images.

Inheritance
System.Object
Optimizer.ImageSettings
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: pdftron.PDF
Assembly: PDFNet.dll
Syntax
public class ImageSettings

Constructors

ImageSettings()

create an ImageSetting object with default options

Declaration
public ImageSettings()

Methods

ForceChanges(Boolean)

Sets whether image changes that grow the PDF file should be kept. This is off by default.

Declaration
public void ForceChanges(bool force)
Parameters
Type Name Description
System.Boolean force

if true all image changes will be kept.

ForceRecompression(Boolean)

Sets whether recompression to the specified compression method should be forced when the image is not downsampled. By default the compression method for these images will not be changed.

Declaration
public void ForceRecompression(bool force)
Parameters
Type Name Description
System.Boolean force

if true the compression method for all images will be changed to the specified compression mode

SetCompressionMode(Optimizer.ImageSettings.CompressionMode)

Sets the output compression mode for this type of image The default value is e_retain

Declaration
public void SetCompressionMode(Optimizer.ImageSettings.CompressionMode mode)
Parameters
Type Name Description
Optimizer.ImageSettings.CompressionMode mode

the compression mode to set

SetDownsampleMode(Optimizer.ImageSettings.DownsampleMode)

Sets the downsample mode for this type of image The default value is e_default

Declaration
public void SetDownsampleMode(Optimizer.ImageSettings.DownsampleMode mode)
Parameters
Type Name Description
Optimizer.ImageSettings.DownsampleMode mode

the downloadsample mode to set

SetImageDPI(Double, Double)

Sets the maximum and resampling dpi for images. By default these are set to 144 and 96 respectively.

Declaration
public void SetImageDPI(double maximum, double resampling)
Parameters
Type Name Description
System.Double maximum

the highest dpi of an image before it will be resampled

System.Double resampling

resampling the image dpi to resample to if an image is encountered over the maximum dpi

SetQuality(Int32)

Declaration
public void SetQuality(int quality)
Parameters
Type Name Description
System.Int32 quality
Back to top Generated by DocFX