# PageImageParams Class

> Used to manage converting a PDF page to an image.

- Product: Adobe PDF Library 18
- Language: Java
- Version: APDFL18.0.5PlusP2e
- HTML page: https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/PageImageParams
- Version index: https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/llms.txt

```java
class PageImageParams
```

**Namespace:** `com::datalogics::PDFL`

## 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`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/Page.md)

**Uses types:** [`ColorSpace`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/ColorSpace.md)

## Constructors

### PageImageParams

```java
com.datalogics.PDFL.PageImageParams.PageImageParams()
```

*constructor*

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

```java
com.datalogics.PDFL.PageImageParams.PageImageParams(ColorSpace ColorSpace, java.util.EnumSet< SmoothFlags > Smoothing, int PixelWidth, int PixelHeight, double HorizontalResolution, double VerticalResolution, java.util.EnumSet< DrawFlags > PageDrawFlags)
```

*constructor*

**Parameters**

- `ColorSpace` ([`ColorSpace`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/ColorSpace.md)): The desired color space for the image, DEVICERGB, DEVICECMYK or DEVICEGRAY only.
- `Smoothing` (`java.util.EnumSet< 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` (`java.util.EnumSet< 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.

## Methods

### delete

```java
synchronized void com.datalogics.PDFL.PageImageParams.delete(Boolean disposing)
```

*protected*

**Parameters**

- `disposing` (`Boolean`)

**Returns:** `synchronized void`

### delete

```java
synchronized void com.datalogics.PDFL.PageImageParams.delete()
```

**Returns:** `synchronized void`

### finalize

```java
void com.datalogics.PDFL.PageImageParams.finalize()
```

*protected*

**Returns:** `void`

### getBlackPointCompensation

```java
boolean com.datalogics.PDFL.PageImageParams.getBlackPointCompensation()
```

**Returns:** `boolean`

The BlackPointCompensation setting. Default is true if not explicitly set.

### getBypassCopyPerm

```java
boolean com.datalogics.PDFL.PageImageParams.getBypassCopyPerm()
```

**Returns:** `boolean`

true if this option is turned on.

The BypassCopyPerm allows to bypass copy permitions.

### getCalibrateDeviceSpacesWhenPrinting

```java
boolean com.datalogics.PDFL.PageImageParams.getCalibrateDeviceSpacesWhenPrinting()
```

**Returns:** `boolean`

true if this option is turned on.

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.

### getHorizontalResolution

```java
double com.datalogics.PDFL.PageImageParams.getHorizontalResolution()
```

**Returns:** `double`

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.

### getICCProfile

```java
ColorProfile com.datalogics.PDFL.PageImageParams.getICCProfile()
```

**Returns:** `ColorProfile`

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.

### getICCProfileCustomPath

```java
String com.datalogics.PDFL.PageImageParams.getICCProfileCustomPath()
```

**Returns:** `String`

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.

### getImageColorSpace

```java
ColorSpace com.datalogics.PDFL.PageImageParams.getImageColorSpace()
```

**Returns:** [`ColorSpace`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/ColorSpace.md)

The ColorSpace used in exporting a PDF page to an image. Must be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, DeviceN, or ICCBased.

### getPageDrawFlags

```java
java.util.EnumSet< DrawFlags > com.datalogics.PDFL.PageImageParams.getPageDrawFlags()
```

**Returns:** `java.util.EnumSet< DrawFlags >`

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.

### getPixelHeight

```java
int com.datalogics.PDFL.PageImageParams.getPixelHeight()
```

**Returns:** `int`

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.

### getPixelWidth

```java
int com.datalogics.PDFL.PageImageParams.getPixelWidth()
```

**Returns:** `int`

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.

### getRenderIntent

```java
RenderIntent com.datalogics.PDFL.PageImageParams.getRenderIntent()
```

**Returns:** `RenderIntent`

The RenderIntent used to specify color translation for colors outside gamut of the color profile used. The default is relative colorimetric.

### getSmoothing

```java
java.util.EnumSet< SmoothFlags > com.datalogics.PDFL.PageImageParams.getSmoothing()
```

**Returns:** `java.util.EnumSet< SmoothFlags >`

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.

### getThinLineHeuristics

```java
boolean com.datalogics.PDFL.PageImageParams.getThinLineHeuristics()
```

**Returns:** `boolean`

true if thin line heuristics are applied, false otherwise.

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

### getUseDeviceNForImageSeparations

```java
boolean com.datalogics.PDFL.PageImageParams.getUseDeviceNForImageSeparations()
```

**Returns:** `boolean`

true if this option is turned on. NOTE: This member is only applicable when calling the GetImageSeparations() method, only when Colorants used are only Process.

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.

### getVerticalResolution

```java
double com.datalogics.PDFL.PageImageParams.getVerticalResolution()
```

**Returns:** `double`

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.

### setBlackPointCompensation

```java
void com.datalogics.PDFL.PageImageParams.setBlackPointCompensation(boolean arg0)
```

**Parameters**

- `arg0` (`boolean`)

**Returns:** `void`

The BlackPointCompensation setting. Default is true if not explicitly set.

### setBypassCopyPerm

```java
void com.datalogics.PDFL.PageImageParams.setBypassCopyPerm(boolean value)
```

**Parameters**

- `value` (`boolean`)

**Returns:** `void`

### setCalibrateDeviceSpacesWhenPrinting

```java
void com.datalogics.PDFL.PageImageParams.setCalibrateDeviceSpacesWhenPrinting(boolean value)
```

**Parameters**

- `value` (`boolean`)

**Returns:** `void`

### setHorizontalResolution

```java
void com.datalogics.PDFL.PageImageParams.setHorizontalResolution(double arg0)
```

**Parameters**

- `arg0` (`double`)

**Returns:** `void`

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.

### setICCProfile

```java
void com.datalogics.PDFL.PageImageParams.setICCProfile(ColorProfile colorProfile)
```

**Parameters**

- `colorProfile` (`ColorProfile`)

**Returns:** `void`

Sets the ICC Profile of the colorspace to be used for rendering to 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.

### setICCProfileCustomPath

```java
void com.datalogics.PDFL.PageImageParams.setICCProfileCustomPath(String colorProfilePath)
```

**Parameters**

- `colorProfilePath` (`String`)

**Returns:** `void`

Sets 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.

### setImageColorSpace

```java
void com.datalogics.PDFL.PageImageParams.setImageColorSpace(ColorSpace cs)
```

**Parameters**

- `cs` ([`ColorSpace`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/ColorSpace.md))

**Returns:** `void`

The ColorSpace used in exporting a PDF page to an image. Must be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, DeviceN, or ICCBased.

### setPageDrawFlags

```java
void com.datalogics.PDFL.PageImageParams.setPageDrawFlags(java.util.EnumSet< DrawFlags > arg0)
```

**Parameters**

- `arg0` (`java.util.EnumSet< DrawFlags >`)

**Returns:** `void`

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.

### setPixelHeight

```java
void com.datalogics.PDFL.PageImageParams.setPixelHeight(int arg0)
```

**Parameters**

- `arg0` (`int`)

**Returns:** `void`

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.

### setPixelWidth

```java
void com.datalogics.PDFL.PageImageParams.setPixelWidth(int arg0)
```

**Parameters**

- `arg0` (`int`)

**Returns:** `void`

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.

### setRenderIntent

```java
void com.datalogics.PDFL.PageImageParams.setRenderIntent(RenderIntent arg0)
```

**Parameters**

- `arg0` (`RenderIntent`)

**Returns:** `void`

The RenderIntent used to specify color translation for colors outside gamut of the color profile used. The default is relative colorimetric.

### setSmoothing

```java
void com.datalogics.PDFL.PageImageParams.setSmoothing(java.util.EnumSet< SmoothFlags > smoothflag)
```

**Parameters**

- `smoothflag` (`java.util.EnumSet< SmoothFlags >`)

**Returns:** `void`

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.

### setThinLineHeuristics

```java
void com.datalogics.PDFL.PageImageParams.setThinLineHeuristics(boolean arg0)
```

**Parameters**

- `arg0` (`boolean`)

**Returns:** `void`

true if thin line heuristics are applied, false otherwise.

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

### setUseDeviceNForImageSeparations

```java
void com.datalogics.PDFL.PageImageParams.setUseDeviceNForImageSeparations(boolean value)
```

**Parameters**

- `value` (`boolean`)

**Returns:** `void`

Sets the UseDeviceNForImageSeparations setting, which indicates when GetImageSeparations() 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.NOTE: This member is only applicable when calling the GetImageSeparations() method, only when Colorants used are only Process.

### setVerticalResolution

```java
void com.datalogics.PDFL.PageImageParams.setVerticalResolution(double arg0)
```

**Parameters**

- `arg0` (`double`)

**Returns:** `void`

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.