\Kendo\UI\TreeListPdf
A PHP class representing the pdf setting of TreeList.
Methods
allPages
Exports all TreeList pages, starting from the first one.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->allPages(true);
?>
author
The author of the PDF document.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->author('value');
?>
autoPrint
Specifies if the Print dialog should be opened immediately after loading the document.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->autoPrint(true);
?>
avoidLinks
(Available as of the 2015.3.1020 release) A flag which indicates whether to produce actual hyperlinks in the exported PDF file. You can also pass a CSS selector as an argument. All matching links will be ignored.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value boolean|string
Example - using boolean
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->avoidLinks(true);
?>
Example - using string
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->avoidLinks('value');
?>
creator
The creator of the PDF document.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->creator('value');
?>
date
The date when the PDF document is created. Defaults to new Date().
Returns
\Kendo\UI\TreeListPdf
Parameters
$value date
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->date(new date());
?>
fileName
Specifies the file name of the exported PDF file.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->fileName('value');
?>
forceProxy
If set to true, the content will be forwarded to proxyURL even if the browser supports the local saving of files.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->forceProxy(true);
?>
jpegQuality
Specifies the quality of the images within the exported file, from 0 to 1.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value float
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$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\TreeListPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->keepPNG(true);
?>
keywords
Specifies the keywords of the exported PDF file.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->keywords('value');
?>
landscape
If set to true, reverses the paper dimensions in such a way that the width becomes the larger edge.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value boolean
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->landscape(true);
?>
margin
Specifies the margins of the page and accepts numbers or strings with units.The supported units are: mm; cm; in or (Default) pt.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value \Kendo\UI\TreeListPdfMargin|array
Example - using \Kendo\UI\TreeListPdfMargin
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$margin = new \Kendo\UI\TreeListPdfMargin();
$bottom = 1;
$margin->bottom($bottom);
$pdf->margin($margin);
?>
Example - using array
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$bottom = 1;
$pdf->margin(array('bottom' => $bottom));
?>
paperSize
Specifies the paper size of the PDF document. The default auto setting means that the paper size is determined by the content.The supported values are: A predefined size such as A4, A3, and so on.; An array of two numbers which specify the width and height in points (1pt = 1/72in). or An array of two strings which specify the width and height in units. The supported units are:mmcminpt.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value string|array
Example - using string
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->paperSize('value');
?>
Example - using array
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->paperSize(array());
?>
proxyTarget
A name or keyword whcih indicates where to display the document that was returned by the proxy. To display the document in a new window or iframe, the proxy will set the Content-Disposition header to inline; filename="
Returns
\Kendo\UI\TreeListPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$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. Such browsers are IE version 9 and earlier, and Safari. The developer is responsible for implementing the server-side proxy. The proxy will return the decoded file with the Content-Disposition header set to attachment; filename="
Returns
\Kendo\UI\TreeListPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->proxyURL('value');
?>
subject
Sets the subject of the PDF file.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->subject('value');
?>
title
Sets the title of the PDF file.
Returns
\Kendo\UI\TreeListPdf
Parameters
$value string
Example
<?php
$pdf = new \Kendo\UI\TreeListPdf();
$pdf->title('value');
?>