WebToPDFConvertParams Class Documentation

classWebToPDFConvertParams : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

On supported platforms, owns a WebToPDFParamsRec and bridges it to a pair of CWebProgressProc/CWebLogProc functors that the static C trampolines installed into the params dispatch through.

On platforms where the WebToPDF plugin is not supported, the same class compiles with a stub state that mirrors the public set/get surface using primitive fields. The stub never throws from the constructor or any setter failures only surface from theDocument.from_web_url /from_html_file entry points (in CDocument.cpp). This keeps configuration code platform-portable.

Public signatures use plain int where the underlying plugin enum would otherwise leak through; numeric values match the plugin enums and the public apiWebViewportPreset /WebPageSize / ... 1:1, so callers cast freely at either boundary.

Constructor & Destructor Documentation

WebToPDFConvertParams

WebToPDFConvertParams()

~WebToPDFConvertParams

~WebToPDFConvertParams()

Property Documentation

CustomPageHeight

doubleCustomPageHeight[get]

CustomPageWidth

doubleCustomPageWidth[get]

CustomViewportHeight

intCustomViewportHeight[get]

CustomViewportWidth

intCustomViewportWidth[get]

DisplayHeaderFooter

boolDisplayHeaderFooter[get, set]

DownsamplingDPI

intDownsamplingDPI[get, set]

EnableVerboseLogging

boolEnableVerboseLogging[get, set]

GenerateTaggedPDF

boolGenerateTaggedPDF[get, set]

ImageCompression

intImageCompression[get, set]

MarginBottom

doubleMarginBottom[get]

MarginLeft

doubleMarginLeft[get]

MarginRight

doubleMarginRight[get]

MarginTop

doubleMarginTop[get]

PageOrientation

intPageOrientation[get, set]

PageSize

intPageSize[get, set]

PreferCSSPageSize

boolPreferCSSPageSize[get, set]

PrintBackground

boolPrintBackground[get, set]

Scale

doubleScale[get, set]

TimeoutSeconds

intTimeoutSeconds[get, set]

ViewportSize

intViewportSize[get, set]

Member Function Documentation

Dispose

voidDispose()

Returns:

void

DisposeChildren

voidDisposeChildren()

Returns:

void

SetCustomPageSize

voidSetCustomPageSize(doublewidth_pts, doubleheight_pts)

Parameters

width_pts: double
height_pts: double

Returns:

void

SetCustomViewport

voidSetCustomViewport(intwidth, intheight)

Parameters

width: int
height: int

Returns:

void

SetMargins

voidSetMargins(doubletop, doubleright, doublebottom, doubleleft)

Parameters

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

Returns:

void