WebToPDFConvertParams Class Documentation

class WebToPDFConvertParams : 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()

Property Documentation

CustomPageHeight

double CustomPageHeight[get]

CustomPageWidth

double CustomPageWidth[get]

CustomViewportHeight

int CustomViewportHeight[get]

CustomViewportWidth

int CustomViewportWidth[get]

DisplayHeaderFooter

bool DisplayHeaderFooter[get, set]

DownsamplingDPI

int DownsamplingDPI[get, set]

EnableVerboseLogging

bool EnableVerboseLogging[get, set]

GenerateTaggedPDF

bool GenerateTaggedPDF[get, set]

ImageCompression

int ImageCompression[get, set]

MarginBottom

double MarginBottom[get]

MarginLeft

double MarginLeft[get]

MarginRight

double MarginRight[get]

MarginTop

double MarginTop[get]

PageOrientation

int PageOrientation[get, set]

PageSize

int PageSize[get, set]

PreferCSSPageSize

bool PreferCSSPageSize[get, set]

PrintBackground

bool PrintBackground[get, set]

Scale

double Scale[get, set]

TimeoutSeconds

int TimeoutSeconds[get, set]

ViewportSize

int ViewportSize[get, set]

Member Function Documentation

Dispose

void Dispose()

Returns:

void

SetCustomPageSize

void SetCustomPageSize(double width_pts, double height_pts)

Parameters

width_pts: double
height_pts: double

Returns:

void

SetCustomViewport

void SetCustomViewport(int width, int height)

Parameters

width: int
height: int

Returns:

void

SetMargins

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

Parameters

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

Returns:

void