WebToPDFConvertParams Class Documentation
classWebToPDFConvertParams : SystemIDisposableNamespace: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
Constructor & Destructor Documentation
WebToPDFConvertParams
WebToPDFConvertParams(WebToPDFConvertParamsrhs, InternalConstructsignifier)Parameters
signifier: InternalConstruct
WebToPDFConvertParams
WebToPDFConvertParams()WebToPDFConvertParams
WebToPDFConvertParams(WebToPDFConvertParamsother)Parameters
other: WebToPDFConvertParams
~WebToPDFConvertParams
~WebToPDFConvertParams()Property Documentation
CustomPageHeight
doubleCustomPageHeight[get]CustomPageWidth
doubleCustomPageWidth[get]CustomViewportHeight
intCustomViewportHeight[get]CustomViewportWidth
intCustomViewportWidth[get]DisplayHeaderFooter
boolDisplayHeaderFooter[get, set]DownsamplingDPI
WebDownsamplingDPIDownsamplingDPI[get, set]EnableVerboseLogging
boolEnableVerboseLogging[get, set]GenerateTaggedPDF
boolGenerateTaggedPDF[get, set]ImageCompression
WebImageCompressionImageCompression[get, set]MarginBottom
doubleMarginBottom[get]MarginLeft
doubleMarginLeft[get]MarginRight
doubleMarginRight[get]MarginTop
doubleMarginTop[get]PageOrientation
WebPageOrientationPageOrientation[get, set]PageSize
WebPageSizePageSize[get, set]PreferCSSPageSize
boolPreferCSSPageSize[get, set]PrintBackground
boolPrintBackground[get, set]Scale
doubleScale[get, set]TimeoutSeconds
intTimeoutSeconds[get, set]ViewportSize
WebViewportPresetViewportSize[get, set]Member Function Documentation
ConstructorRetrieve
static WebToPDFConvertParamsConstructorRetrieve(System.IntPtrignored)Parameters
ignored: System.IntPtr
Returns:
WebToPDFConvertParamsDispose
voidDispose()Returns:
voidDisposeChildren
voidDisposeChildren()Returns:
voidSetCustomPageSize
voidSetCustomPageSize(doublewidth_pts, doubleheight_pts)Parameters
width_pts: doubleheight_pts: double
Returns:
voidExplicit page size in points (1 pt = 1/72 in). Used only when the page size is Custom.
SetCustomViewport
voidSetCustomViewport(intwidth, intheight)Parameters
width: intheight: int
Returns:
voidExplicit viewport size in pixels. Used only when the viewport preset is Custom.
SetMargins
voidSetMargins(doubletop, doubleright, doublebottom, doubleleft)Parameters
top: doubleright: doublebottom: doubleleft: double
Returns:
voidPage margins in inches, given as top, right, bottom, left.