\Kendo\UI\GridPdf
A PHP class representing the pdf setting of Grid.
Methods
allPages
Exports all grid pages, starting from the first one.
Returns
\Kendo\UI\GridPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->allPages(true);
?>
author
The author of the PDF document.
Returns
\Kendo\UI\GridPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->author('value');
?>
autoPrint
Specifies if the Print dialog should be opened immediately after loading the document.
Returns
\Kendo\UI\GridPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->autoPrint(true);
?>
avoidLinks
A flag indicating whether to produce actual hyperlinks in the exported PDF file.It's also possible to pass a CSS selector as argument. All matching links will be ignored.
Returns
\Kendo\UI\GridPdf
Parameters
$value boolean|string
Example - using boolean
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->avoidLinks(true);
?>
Example - using string
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->avoidLinks('value');
?>
creator
The creator of the PDF document.
Returns
\Kendo\UI\GridPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->creator('value');
?>
date
The date when the PDF document is created. Defaults to new Date().
Returns
\Kendo\UI\GridPdf
Parameters
$value date
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->date(new date());
?>
fileName
Specifies the file name of the exported PDF file.
Returns
\Kendo\UI\GridPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->fileName('value');
?>
forceProxy
If set to true, the content will be forwarded to proxyURL even if the browser supports saving files locally.
Returns
\Kendo\UI\GridPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->forceProxy(true);
?>
jpegQuality
Specifies the quality of the images within the exported file, from 0 to 1.
Returns
\Kendo\UI\GridPdf
Parameters
$value float
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->jpegQuality(1);
?>
keepPNG
If set to true all PNG images contained in the exported file will be kept in PNG format.
Returns
\Kendo\UI\GridPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->keepPNG(true);
?>
keywords
Specifies the keywords of the exported PDF file.
Returns
\Kendo\UI\GridPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->keywords('value');
?>
landscape
Set to true to reverse the paper dimensions if needed such that width is the larger edge.
Returns
\Kendo\UI\GridPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->landscape(true);
?>
margin
Specifies the margins of the page (numbers or strings with units). Supported units are "mm", "cm", "in" and "pt" (default).
Returns
\Kendo\UI\GridPdf
Parameters
$value \Kendo\UI\GridPdfMargin|array
Example - using \Kendo\UI\GridPdfMargin
<?php
$pdf = new \Kendo\UI\GridPdf();
$margin = new \Kendo\UI\GridPdfMargin();
$bottom = 1;
$margin->bottom($bottom);
$pdf->margin($margin);
?>
Example - using array
<?php
$pdf = new \Kendo\UI\GridPdf();
$bottom = 1;
$pdf->margin(array('bottom' => $bottom));
?>
paperSize
Specifies the paper size of the PDF document. The default "auto" means paper size is determined by content.Supported values: A predefined size: "A4", "A3" etc; An array of two numbers specifying the width and height in points (1pt = 1/72in) or An array of two strings specifying the width and height in units. Supported units are "mm", "cm", "in" and "pt"..
Returns
\Kendo\UI\GridPdf
Parameters
$value string|array
Example - using string
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->paperSize('value');
?>
Example - using array
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->paperSize(array());
?>
proxyTarget
A name or keyword indicating where to display the document returned from the proxy.If you want to display the document in a new window or iframe, the proxy should set the "Content-Disposition" header to inline; filename="
Returns
\Kendo\UI\GridPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->proxyTarget('value');
?>
proxyURL
The URL of the server side proxy which will stream the file to the end user.A proxy will be used when the browser is not capable of saving files locally, for example, Internet Explorer 9 and Safari.The developer is responsible for implementing the server-side proxy.The proxy will receive a POST request with the following parameters in the request body: contentType: The MIME type of the file; base64: The base-64 encoded file content or fileName: The file name, as requested by the caller.. The proxy should return the decoded file with the "Content-Disposition" header set toattachment; filename="
Returns
\Kendo\UI\GridPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->proxyURL('value');
?>
repeatHeaders
Set this to true to repeat the grid headers on each page.
Returns
\Kendo\UI\GridPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->repeatHeaders(true);
?>
scale
A scale factor. In many cases, text size on screen will be too big for print, so you can use this option to scale down the output in PDF. See the documentation in drawDOM.
Returns
\Kendo\UI\GridPdf
Parameters
$value float
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->scale(1);
?>
subject
Sets the subject of the PDF file.
Returns
\Kendo\UI\GridPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->subject('value');
?>
template
A piece of HTML to be included in each page. Can be used to display headers and footers. See the documentation in drawDOM.Available template variables include: * pageNum * totalPages
Returns
\Kendo\UI\GridPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->template('value');
?>
title
Sets the title of the PDF file.
Returns
\Kendo\UI\GridPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\GridPdf();
$pdf->title('value');
?>