GridPDFExportProps

Premium

The props of the GridPDFExport component (more information and examples in the documentation on PDF export).

Name	Type	Default	Description
author?	string		The author (metadata) of the PDF document. jsx <PDFExport author="John Doe" />
avoidLinks?	string | boolean		Sets whether to produce actual hyperlinks in the exported PDF file. It is also possible to set a CSS selector. All matching links will be ignored. jsx <PDFExport avoidLinks={true} /> <PDFExport avoidLinks=".no-link" />
creator?	string	"KendoReact PDF Generator"	Sets the creator of the PDF document.
date?	Date	new Date()	Sets the date when the PDF document is created.
fileName?	string	"export.pdf"	Sets the name of the exported PDF file. jsx <PDFExport fileName="custom-file.pdf" />
forcePageBreak?	string		Sets a CSS selector that determines the elements which cause the page breaks. jsx <PDFExport forcePageBreak=".page-break" />
forceProxy?	boolean		If set to true, the content is forwarded to proxyURL even if the browser supports local saving of files.
imageResolution?	number		The forced resolution of the images in the exported PDF document. By default, the images are exported at their full resolution.
keepTogether?	string		Sets a CSS selector that determines the elements which should not be split across the pages. jsx <PDFExport keepTogether=".keep-together" />
keywords?	string		The keywords (metadata) of the PDF document.
landscape?	boolean	false	Indicates if the page is in a landscape orientation. By default, the page is in a portrait orientation.
margin?	string | number | PageMargin		Sets the margins of the page. The supported units are: "mm" "cm" "in" "pt" (default). Numbers are considered to be points ("pt").
pageTemplate?	any		A React functional or class component which is used as a template that is inserted into each page of the PDF document. The number of the current page (pageNum) and the total number of pages (totalPages) are passed to the component as properties.
paperSize?	PaperSize	"auto"	Sets the paper size of the PDF document. If set, the content will be split across multiple pages. This enables the repeatHeaders and scale options, and allows you to specify a template. The supported values are: A predefined size. The supported paper sizes are: A0-A10, B0-B10, C0-C10, Executive, Folio, Legal, Letter, Tabloid. An array of two numbers which specify the width and height in points (1pt = 1/72in). An array of two strings which specify the width and height in units. The supported units are "mm", "cm", "in", and "pt". jsx <PDFExport paperSize="A4" />
producer?	string		The producer (metadata) of the PDF document.
proxyData?	{[key: string]: string}		Sets a key/value dictionary of form values for the proxy. You can use it to submit Anti-Forgery tokens and other metadata.
proxyTarget?	string	"_self"	Sets a name or keyword which indicates where to display the document that is returned from the proxy. To display the document in a new window or iframe, the proxy has to have the "Content-Disposition" header set to inline; filename="<fileName.pdf>".
proxyURL?	string		The URL of the server-side proxy which streams the file to the end user. You need to use a proxy if the browser is not capable of saving files locally—for example, Internet Explorer 9 and Safari. It is your responsibility to implement the server-side proxy. In the request body, the proxy receives a POST request with the following parameters: "contentType"—The MIME type of the file. "base64"—The base-64 encoded file content. "fileName"—The file name, as requested by the caller. The proxy returns the decoded file with the "Content-Disposition" header set to attachment; filename="<fileName.pdf>".
repeatHeaders?	boolean		Sets if the <thead> elements of the tables are repeated on each page. jsx <PDFExport repeatHeaders={true} />
scale?	number	1	Sets a scale factor for the PDF content. jsx <PDFExport scale={0.8} />
subject?	string		The subject (metadata) of the PDF document.
title?	string		The title (metadata) of the PDF document.