WebToPDFConvertParams Class Documentation

class WebToPDFConvertParams

Namespace:com::datalogics::PDFL

Detailed Description

Parameters that control web/HTML-to-PDF conversion. Configure the target page geometry, viewport, image handling, and behavior on this object, then pass it to a web-to-PDF conversion call. The enum-valued settings (viewport preset, page size, page orientation, image compression, and downsampling resolution) take named values rather than raw integers. Safe to construct and configure on any platform; conversion itself runs only where the WebToPDF plugin is supported.

Referenced by

DocumentWebToPDFConvertParams

Constructor & Destructor Documentation

WebToPDFConvertParams

WebToPDFConvertParams()

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getCustomPageHeight

double getCustomPageHeight()

Returns:

double

getCustomPageWidth

double getCustomPageWidth()

Returns:

double

getCustomViewportHeight

int getCustomViewportHeight()

Returns:

int

getCustomViewportWidth

int getCustomViewportWidth()

Returns:

int

getDisplayHeaderFooter

boolean getDisplayHeaderFooter()

Returns:

boolean

getDownsamplingDPI

WebDownsamplingDPI getDownsamplingDPI()

Returns:

WebDownsamplingDPI

getEnableVerboseLogging

boolean getEnableVerboseLogging()

Returns:

boolean

getGenerateTaggedPDF

boolean getGenerateTaggedPDF()

Returns:

boolean

getImageCompression

WebImageCompression getImageCompression()

Returns:

WebImageCompression

getMarginBottom

double getMarginBottom()

Returns:

double

getMarginLeft

double getMarginLeft()

Returns:

double

getMarginRight

double getMarginRight()

Returns:

double

getMarginTop

double getMarginTop()

Returns:

double

getPageOrientation

WebPageOrientation getPageOrientation()

Returns:

WebPageOrientation

getPageSize

WebPageSize getPageSize()

Returns:

WebPageSize

getPreferCSSPageSize

boolean getPreferCSSPageSize()

Returns:

boolean

getPrintBackground

boolean getPrintBackground()

Returns:

boolean

getScale

double getScale()

Returns:

double

getTimeoutSeconds

int getTimeoutSeconds()

Returns:

int

getViewportSize

WebViewportPreset getViewportSize()

Returns:

WebViewportPreset

setCustomPageSize

void setCustomPageSize(double width_pts, double height_pts)

Parameters

width_pts: double
height_pts: double

Returns:

void

Explicit page size in points (1 pt = 1/72 in).Used only when the page size is Custom.

setCustomViewport

void setCustomViewport(int width, int height)

Parameters

width: int
height: int

Returns:

void

Explicit viewport size in pixels.Used only when the viewport preset is Custom.

setDisplayHeaderFooter

void setDisplayHeaderFooter(boolean v)

Parameters

v: boolean

Returns:

void

Show the default browser-style header and footer.

setDownsamplingDPI

void setDownsamplingDPI(WebDownsamplingDPI v)

Parameters

v: WebDownsamplingDPI

Returns:

void

Downsampling resolution for raster images. Use the Disabled value to preserve the original resolution.

setEnableVerboseLogging

void setEnableVerboseLogging(boolean v)

Parameters

v: boolean

Returns:

void

Emit debug-level log messages during conversion.

setGenerateTaggedPDF

void setGenerateTaggedPDF(boolean v)

Parameters

v: boolean

Returns:

void

Produce a tagged (accessible) PDF.

setImageCompression

void setImageCompression(WebImageCompression v)

Parameters

v: WebImageCompression

Returns:

void

Compression applied to raster images embedded in the output PDF.

setMargins

void setMargins(double top, double right, double bottom, double left)

Parameters

top: double
right: double
bottom: double
left: double

Returns:

void

Page margins in inches, given as top, right, bottom, left.

setPageOrientation

void setPageOrientation(WebPageOrientation v)

Parameters

v: WebPageOrientation

Returns:

void

Output page orientation (portrait or landscape).

setPageSize

void setPageSize(WebPageSize v)

Parameters

v: WebPageSize

Returns:

void

Output page size. Use the Custom value together with SetCustomPageSize to specify an explicit size in points.

setPreferCSSPageSize

void setPreferCSSPageSize(boolean v)

Parameters

v: boolean

Returns:

void

setPrintBackground

void setPrintBackground(boolean v)

Parameters

v: boolean

Returns:

void

Print CSS background colors and images.

setScale

void setScale(double v)

Parameters

v: double

Returns:

void

Content scale factor (1.0 = 100%).

setTimeoutSeconds

void setTimeoutSeconds(int v)

Parameters

v: int

Returns:

void

Conversion timeout in seconds: 0 = plugin default (300s), -1 = infinite, positive = an explicit number of seconds.

setViewportSize

void setViewportSize(WebViewportPreset v)

Parameters

v: WebViewportPreset

Returns:

void

Viewport preset controlling the size of the rendering surface. Use the Custom preset together with SetCustomViewport to specify an explicit pixel size.