WebToPDFConvertParams Class Documentation

class WebToPDFConvertParams : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

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()

Property Documentation

CustomPageHeight

double CustomPageHeight[get]

CustomPageWidth

double CustomPageWidth[get]

CustomViewportHeight

int CustomViewportHeight[get]

CustomViewportWidth

int CustomViewportWidth[get]

DisplayHeaderFooter

bool DisplayHeaderFooter[get, set]

DownsamplingDPI

WebDownsamplingDPI DownsamplingDPI[get, set]

EnableVerboseLogging

bool EnableVerboseLogging[get, set]

GenerateTaggedPDF

bool GenerateTaggedPDF[get, set]

ImageCompression

WebImageCompression ImageCompression[get, set]

MarginBottom

double MarginBottom[get]

MarginLeft

double MarginLeft[get]

MarginRight

double MarginRight[get]

MarginTop

double MarginTop[get]

PageOrientation

WebPageOrientation PageOrientation[get, set]

PageSize

WebPageSize PageSize[get, set]

PreferCSSPageSize

bool PreferCSSPageSize[get, set]

PrintBackground

bool PrintBackground[get, set]

Scale

double Scale[get, set]

TimeoutSeconds

int TimeoutSeconds[get, set]

ViewportSize

WebViewportPreset 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

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.

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.