WebToPDFConvertParams Class Documentation

classWebToPDFConvertParams

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

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getCustomPageHeight

doublegetCustomPageHeight()

Returns:

double

getCustomPageWidth

doublegetCustomPageWidth()

Returns:

double

getCustomViewportHeight

intgetCustomViewportHeight()

Returns:

int

getCustomViewportWidth

intgetCustomViewportWidth()

Returns:

int

getDisplayHeaderFooter

booleangetDisplayHeaderFooter()

Returns:

boolean

getDownsamplingDPI

WebDownsamplingDPIgetDownsamplingDPI()

Returns:

WebDownsamplingDPI

getEnableVerboseLogging

booleangetEnableVerboseLogging()

Returns:

boolean

getGenerateTaggedPDF

booleangetGenerateTaggedPDF()

Returns:

boolean

getImageCompression

WebImageCompressiongetImageCompression()

Returns:

WebImageCompression

getMarginBottom

doublegetMarginBottom()

Returns:

double

getMarginLeft

doublegetMarginLeft()

Returns:

double

getMarginRight

doublegetMarginRight()

Returns:

double

getMarginTop

doublegetMarginTop()

Returns:

double

getPageOrientation

WebPageOrientationgetPageOrientation()

Returns:

WebPageOrientation

getPageSize

WebPageSizegetPageSize()

Returns:

WebPageSize

getPreferCSSPageSize

booleangetPreferCSSPageSize()

Returns:

boolean

getPrintBackground

booleangetPrintBackground()

Returns:

boolean

getScale

doublegetScale()

Returns:

double

getTimeoutSeconds

intgetTimeoutSeconds()

Returns:

int

getViewportSize

WebViewportPresetgetViewportSize()

Returns:

WebViewportPreset

setCustomPageSize

voidsetCustomPageSize(doublewidth_pts, doubleheight_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

voidsetCustomViewport(intwidth, intheight)

Parameters

width: int
height: int

Returns:

void

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

setDisplayHeaderFooter

voidsetDisplayHeaderFooter(booleanv)

Parameters

v: boolean

Returns:

void

Show the default browser-style header and footer.

setDownsamplingDPI

voidsetDownsamplingDPI(WebDownsamplingDPIv)

Parameters

v: WebDownsamplingDPI

Returns:

void

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

setEnableVerboseLogging

voidsetEnableVerboseLogging(booleanv)

Parameters

v: boolean

Returns:

void

Emit debug-level log messages during conversion.

setGenerateTaggedPDF

voidsetGenerateTaggedPDF(booleanv)

Parameters

v: boolean

Returns:

void

Produce a tagged (accessible) PDF.

setImageCompression

voidsetImageCompression(WebImageCompressionv)

Parameters

v: WebImageCompression

Returns:

void

Compression applied to raster images embedded in the output PDF.

setMargins

voidsetMargins(doubletop, doubleright, doublebottom, doubleleft)

Parameters

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

Returns:

void

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

setPageOrientation

voidsetPageOrientation(WebPageOrientationv)

Parameters

v: WebPageOrientation

Returns:

void

Output page orientation (portrait or landscape).

setPageSize

voidsetPageSize(WebPageSizev)

Parameters

v: WebPageSize

Returns:

void

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

setPreferCSSPageSize

voidsetPreferCSSPageSize(booleanv)

Parameters

v: boolean

Returns:

void

setPrintBackground

voidsetPrintBackground(booleanv)

Parameters

v: boolean

Returns:

void

Print CSS background colors and images.

setScale

voidsetScale(doublev)

Parameters

v: double

Returns:

void

Content scale factor (1.0 = 100%).

setTimeoutSeconds

voidsetTimeoutSeconds(intv)

Parameters

v: int

Returns:

void

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

setViewportSize

voidsetViewportSize(WebViewportPresetv)

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.