\Kendo\UI\SpreadsheetPdf

A PHP class representing the pdf setting of Spreadsheet.

Methods

area

The area to export. Possible values:

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->area('value');
?>

author

The author of the PDF document.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->author('value');
?>

creator

The creator of the PDF document.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->creator('value');
?>

date

The date when the PDF document is created. Defaults to new Date().

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value date

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->date(new date());
?>

fileName

Specifies the file name of the exported PDF file.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->fileName('value');
?>

fitWidth

An option indicating whether to fit the spreadsheet content to page width.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value boolean

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->fitWidth(true);
?>

forceProxy

If set to true, the content will be forwarded to proxyURL even if the browser supports saving files locally.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value boolean

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->forceProxy(true);
?>

guidelines

An option indicating whether to export the cell guidelines.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value boolean

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->guidelines(true);
?>

hCenter

An option indicating whether to center the content horizontally.See also vCenter.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value boolean

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->hCenter(true);
?>

keywords

Specifies the keywords of the exported PDF file.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->keywords('value');
?>

landscape

Set to true to reverse the paper dimensions if needed such that width is the larger edge.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value boolean

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$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\SpreadsheetPdf

Parameters

$value \Kendo\UI\SpreadsheetPdfMargin |array

Example - using \Kendo\UI\SpreadsheetPdfMargin

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$margin = new \Kendo\UI\SpreadsheetPdfMargin();
$bottom = 1;
$margin->bottom($bottom);
$pdf->margin($margin);
?>

Example - using array

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$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:

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value string |array

Example - using string

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->paperSize('value');
?>

Example - using array

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$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\SpreadsheetPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$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:The proxy should return the decoded file with the "Content-Disposition" header set to attachment; filename="".

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->proxyURL('value');
?>

subject

Sets the subject of the PDF file.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->subject('value');
?>

title

Sets the title of the PDF file.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->title('value');
?>

vCenter

An option indicating whether to center the content vertically.See also hCenter.

Returns

\Kendo\UI\SpreadsheetPdf

Parameters

$value boolean

Example

<?php
$pdf = new \Kendo\UI\SpreadsheetPdf();
$pdf->vCenter(true);
?>
Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article

close
Dummy