PageImageParams Class

class PageImageParams : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

Used to manage converting a PDF page to an image.

The Page Image Parameters are a set of parameters used to control converting a PDF page to an image, such as a PNG, JPG, or BMP. The parameters include pixel height & width, color space, resolution, so on.

Referenced by

Page

Uses types

ColorProfile ColorSpace DrawFlags RenderIntent SmoothFlags

Constructor & Destructor Documentation

PageImageParams()

Construct default PageImageParams.

Initializes with DeviceRGB color space, no smoothing, zero pixel dimensions, 300 dpi resolution, relative colorimetric render intent, and black point compensation enabled.

PageImageParams(ColorSpace ColorSpace, SmoothFlags Smoothing, int PixelWidth, int PixelHeight, double HorizontalResolution, double VerticalResolution, DrawFlags PageDrawFlags)

Parameters

ColorSpace: ColorSpace: The desired color space for the image, DEVICERGB, DEVICECMYK or DEVICEGRAY only.
Smoothing: SmoothFlags: Indicates what parts of PDF Page (text, image, art, none) are to be smoothed in rendering to an image. Note these flags can be or'd together
PixelWidth: int: The desired witdth in pixels of the output image.
PixelHeight: int: The desired height in pixels of the output image.
HorizontalResolution: double: The desired horizontal resolution in pixels/inch of the output image. If you pass in 0.0, 300.0 dpi is used.
VerticalResolution: double: The desired vertical resolution in pixels/inch of the output image. If you pass in 0.0, 300.0 dpi is used.
PageDrawFlags: DrawFlags: An OR of the flags from DrawFlags which control how the PDF page is to be drawn.

Set up the parameters for rendering a PDF page to an image.

Horizontal and Vertical Resolution have to be either both zero or both non-zero.

Property Documentation

bool BlackPointCompensation[get, set]

The BlackPointCompensation setting.

Default is true if not explicitly set.

bool BypassCopyPerm[get, set]

The BypassCopyPerm allows to bypass copy permitions.

bool CalibrateDeviceSpacesWhenPrinting[get, set]

Sets if Device spaces should be treated as calibrated to the associated working profile (when true), otherwise it treats them as uncalibrated (when false) when printing.

double HorizontalResolution[get, set]

The desired horizontal resolution in pixels/inch of the output image.

Defaults to 300 dpi. Must not be negative. Horizontal and vertical resolution must be either both zero or both non-zero.

ColorProfile ICCProfile[get, set]

Gets the ICC Profile of the colorspace to be used for rendering from a known value.

NOTE: The ICCProfileCustomPath must not be set for this property to be used. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

string ICCProfileCustomPath[get, set]

Gets the ICC Profile of the colorspace to be used for rendering from a custom file path.

NOTE: The ICCProfile is ignored when this property is a non-empty string. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

ColorSpace ImageColorSpace[get, set]

The ColorSpace used in exporting a PDF page to an image.

Must be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, DeviceN, or ICCBased.

DrawFlags PageDrawFlags[get, set]

The DrawFlags used for rendering a PDF page to an image.

An OR of the flags from DrawFlags which control how the PDF page is drawn.

int PixelHeight[get, set]

The height in pixels of the image to be created from a PDF page.

If not specified (zero), the rendered PDF page size will be used. PixelWidth and PixelHeight must be either both zero or both non-zero.

int PixelWidth[get, set]

The width in pixels of the image to be created from a PDF page.

If not specified (zero), the rendered PDF page size will be used. PixelWidth and PixelHeight must be either both zero or both non-zero.

RenderIntent RenderIntent[get, set]

The RenderIntent used to specify color translation for colors outside gamut of the color profile used.

The default is relative colorimetric.

SmoothFlags Smoothing[get, set]

The SmoothFlags used in exporting a PDF page to an image.

Indicates what parts of the PDF page (text, image, art, none) are to be smoothed when rendering to an image. These flags can be OR'd together.

bool ThinLineHeuristics[get, set]

The ThinLineHeuristics setting.

Determines whether thin lines will be fattened non-linearly or the stroke adjust will be applied to thin rectangles.

bool UseDeviceNForImageSeparations[get, set]

Gets the UseDeviceNForImageSeparations setting, which indicates when the GetImageSeparations() method is called if a DeviceN colorspace will be used for rasterization. When false, if only Process colorants are provided to GetImageSeparations() then it's rendered using DeviceCMYK. When true, then it's rendered using DeviceN.

double VerticalResolution[get, set]

The desired vertical resolution in pixels/inch of the output image.

Defaults to 300 dpi. Must not be negative. Horizontal and vertical resolution must be either both zero or both non-zero.

Member Function Documentation

void Dispose()

Returns:

void