PDFComponent

Configures the settings for the export of TreeList in PDF (see example).

Selector

kendo-treelist-pdf

Inputs

Name	Type	Default	Description
allPages	boolean		Exports all TreeList pages, starting from the first one.
author	string		Sets the author metadata for the PDF document.
autoPrint?	boolean	false	If true, opens the Print dialog immediately after the PDF loads (see example). Requires @progress/kendo-drawing v1.9.0 or later.
avoidLinks	string | boolean		Specifies whether actual hyperlinks will be produced in the exported PDF file (see example). You can also set a CSS selector to ignore matching links.
creator	string	"Kendo UI PDF Generator"	Sets the creator metadata for the PDF document.
date	Date	new Date()	Sets the creation date for the PDF document. Defaults to new Date().
fileName	string	"export.pdf"	Sets the name of the exported PDF file.
forcePageBreak	string		Sets a CSS selector for elements that cause page breaks (see example).
forceProxy	boolean		If true, forwards content to proxyURL even if the browser supports local file saving.
imageResolution	number		Sets the image resolution in the exported PDF (see example). By default, images use full resolution.
keepTogether	string		Sets a CSS selector for elements that should not split across pages (see example).
keywords	string		Sets the keywords metadata for the PDF document.
landscape	boolean	false	If true, sets the page orientation to landscape. The default page orientation is portrait.
margin	string | number | PageMargin		Sets the page margins. Numbers use points ("pt").
paperSize	PaperSize	"auto"	Sets the paper size for the PDF document. Defaults to "auto", which means the content determines the size of the document. The size of the content in pixels matches the size of the output in points (1 pixel = 1/72 inch). If set, the content splits across pages, and allows you to use repeatHeaders, scale, and a template. The value can be a PaperSize, an array of two numbers (width and height in points), or an array of two strings (width and height in units: "mm", "cm", "in", or "pt").
producer	string		Sets the producer metadata for the PDF document.
proxyData?	{[key: string]: string}		Sets a key/value dictionary of form values sent to the proxy. Use this to send extra data, like Anti-Forgery tokens.
proxyTarget	string	"_self"	Sets where to display the document returned from the proxy. Use "_self" to display in the same window. To display the document in a new window or iframe, the proxy must have the "Content-Disposition" header set to inline; filename="<fileName.pdf>".
proxyURL	string		Sets the server-side proxy URL for streaming the file to the user. You need to implement a proxy if the browser is not capable of saving files locally. The proxy returns the decoded file with the "Content-Disposition" header set to attachment; filename="<fileName.pdf>". In the request body, the proxy receives a POST request with the specific parameters (see example).
repeatHeaders	boolean		If true, repeats the <thead> elements of tables on each page. This helps keep table headers visible on every page (see example).
scale	number	1	Sets a scale factor for the PDF output. Use this to make the PDF content smaller or larger (see example).
subject	string		Sets the subject metadata for the PDF document.
title	string		Sets the title metadata for the PDF document.

Methods

export
Exports the content as a Group for further processing.
Returns Promise<Group> The root group of the exported scene.

saveAs
Saves the content as a PDF file with the specified name.
Parameters fileName string The name of the exported file.