Edit this page

Kendo.Mvc.UI.Fluent.SpreadsheetPdfSettingsBuilder

Defines the fluent API for configuring the SpreadsheetPdfSettings settings.

Methods

Area(System.String)

The area to export. Possible values: "workbook": Exports the full workbook, including all sheets.; "sheet": Exports the active sheet. or "selection": Exports the selected area on the active sheet..

Parameters

value System.String

The value that configures the area.

Author(System.String)

The author of the PDF document.

Parameters

value System.String

The value that configures the author.

Creator(System.String)

The creator of the PDF document.

Parameters

value System.String

The value that configures the creator.

Date(System.DateTime)

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

Parameters

value System.DateTime

The value that configures the date.

FileName(System.String)

Specifies the file name of the exported PDF file.

Parameters

value System.String

The value that configures the filename.

FitWidth(System.Boolean)

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

Parameters

value System.Boolean

The value that configures the fitwidth.

ForceProxy(System.Boolean)

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

Parameters

value System.Boolean

The value that configures the forceproxy.

Guidelines(System.Boolean)

An option indicating whether to export the cell guidelines.

Parameters

value System.Boolean

The value that configures the guidelines.

HCenter(System.Boolean)

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

Parameters

value System.Boolean

The value that configures the hcenter.

Keywords(System.String)

Specifies the keywords of the exported PDF file.

Parameters

value System.String

The value that configures the keywords.

Landscape(System.Boolean)

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

Parameters

value System.Boolean

The value that configures the landscape.

Margin(System.Action<Kendo.Mvc.UI.Fluent.SpreadsheetPdfMarginSettingsBuilder>)

Specifies the margins of the page (numbers or strings with units). Supported units are "mm", "cm", "in" and "pt" (default).

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.SpreadsheetPdfMarginSettingsBuilder>

The action that configures the margin.

PaperSize(System.String)

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"..

Parameters

value System.String

The value that configures the papersize.

ProxyURL(System.String)

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="".

Parameters

value System.String

The value that configures the proxyurl.

ProxyTarget(System.String)

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="".

Parameters

value System.String

The value that configures the proxytarget.

Subject(System.String)

Sets the subject of the PDF file.

Parameters

value System.String

The value that configures the subject.

Title(System.String)

Sets the title of the PDF file.

Parameters

value System.String

The value that configures the title.

VCenter(System.Boolean)

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

Parameters

value System.Boolean

The value that configures the vcenter.