cdp/dev.kdriver.cdp.domain/Page/printToPDF

printToPDF

suspend fun printToPDF(args: Page.PrintToPDFParameter, mode: CommandMode = CommandMode.DEFAULT): Page.PrintToPDFReturn

Print page as PDF.

suspend fun printToPDF(landscape: Boolean? = null, displayHeaderFooter: Boolean? = null, printBackground: Boolean? = null, scale: Double? = null, paperWidth: Double? = null, paperHeight: Double? = null, marginTop: Double? = null, marginBottom: Double? = null, marginLeft: Double? = null, marginRight: Double? = null, pageRanges: String? = null, headerTemplate: String? = null, footerTemplate: String? = null, preferCSSPageSize: Boolean? = null, transferMode: String? = null, generateTaggedPDF: Boolean? = null, generateDocumentOutline: Boolean? = null): Page.PrintToPDFReturn

Print page as PDF.

Parameters

landscape

Paper orientation. Defaults to false.

displayHeaderFooter

Display header and footer. Defaults to false.

printBackground

Print background graphics. Defaults to false.

scale

Scale of the webpage rendering. Defaults to 1.

paperWidth

Paper width in inches. Defaults to 8.5 inches.

paperHeight

Paper height in inches. Defaults to 11 inches.

marginTop

Top margin in inches. Defaults to 1cm (~0.4 inches).

marginBottom

Bottom margin in inches. Defaults to 1cm (~0.4 inches).

marginLeft

Left margin in inches. Defaults to 1cm (~0.4 inches).

marginRight

Right margin in inches. Defaults to 1cm (~0.4 inches).

pageRanges

Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.

headerTemplate

HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:

  • date: formatted print date

  • title: document title

  • url: document location

  • pageNumber: current page number

  • totalPages: total pages in the document

For example, <span class=title></span> would generate span containing the title.

footerTemplate

HTML template for the print footer. Should use the same format as the headerTemplate.

preferCSSPageSize

Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.

transferMode

return as stream

generateTaggedPDF

Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.

generateDocumentOutline

Whether or not to embed the document outline into the PDF.