SpreadsheetPdfSettingsBuilder
Methods
Area(System.String)
The area that will be exported.The supported values are: * workbook - Exports the full workbook, including all sheets. * sheet - Exports the active sheet. * selection - Exports the selected area on the active sheet.
Parameters
value - System.String
The value for Area
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Area("selection"))
)
Author(System.String)
The author of the PDF document.
Parameters
value - System.String
The value for Author
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Author("John Doe"))
)
AutoPrint(System.Boolean)
Specifies if the Print dialog should be opened immediately after loading the document.
Parameters
value - System.Boolean
The value for AutoPrint
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.AutoPrint(true))
)
AutoPrint()
Specifies if the Print dialog should be opened immediately after loading the document.
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.AutoPrint(true))
)
Creator(System.String)
The creator of the PDF document.
Parameters
value - System.String
The value for Creator
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Creator("John Doe"))
)
Date(System.DateTime)
The date when the PDF document is created. Defaults to new Date().
Parameters
value - System.DateTime
The value for Date
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Date(DateTime.Now))
)
FileName(System.String)
Specifies the file name of the exported PDF file.
Parameters
value - System.String
The value for FileName
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.FileName("Sheet1.pdf"))
)
FitWidth(System.Boolean)
Indicates whether to fit the content of the Spreadsheet to the width of the page.
Parameters
value - System.Boolean
The value for FitWidth
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.FitWidth(true))
)
FitWidth()
Indicates whether to fit the content of the Spreadsheet to the width of the page.
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.FitWidth(true))
)
ForceProxy(System.Boolean)
If set to true, the content will be forwarded to proxyURL even if the browser supports the saving of files locally.
Parameters
value - System.Boolean
The value for ForceProxy
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.ForceProxy(true))
)
ForceProxy()
If set to true, the content will be forwarded to proxyURL even if the browser supports the saving of files locally.
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.ForceProxy(true))
)
Guidelines(System.Boolean)
Indicates whether to export the cell guidelines.
Parameters
value - System.Boolean
The value for Guidelines
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Guidelines(true))
)
Guidelines()
Indicates whether to export the cell guidelines.
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Guidelines(true))
)
HCenter(System.Boolean)
Indicates whether to center the content horizontally. For more information, refer to vCenter.
Parameters
value - System.Boolean
The value for HCenter
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.HCenter(true))
)
HCenter()
Indicates whether to center the content horizontally. For more information, refer to vCenter.
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.HCenter(true))
)
JpegQuality(System.Double)
Specifies the quality of the images within the exported file, from 0 to 1.
Parameters
value - System.Double
The value for JpegQuality
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.JpegQuality(1))
)
KeepPNG(System.Boolean)
If set to true all PNG images contained in the exported file will be kept in PNG format.
Parameters
value - System.Boolean
The value for KeepPNG
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.KeepPNG(true))
)
KeepPNG()
If set to true all PNG images contained in the exported file will be kept in PNG format.
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.KeepPNG(true))
)
Keywords(System.String)
Specifies the keywords of the exported PDF file.
Parameters
value - System.String
The value for Keywords
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Keywords("food order"))
)
Landscape(System.Boolean)
If set to true, reverses the paper dimensions if that width is needed as the larger edge.
Parameters
value - System.Boolean
The value for Landscape
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Landscape(true))
)
Margin(System.Action)
Specifies the margins of the page (numbers or strings with units).The supported values are: mm; cm; in or pt (default).
Parameters
configurator - System.Action<SpreadsheetPdfMarginSettingsBuilder>
The configurator for the margin setting.
RETURNS
Returns the current instance of SpreadsheetPdfSettingsBuilder .
PaperSize(System.String)
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 - A4, A3, and so on. * 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 values are mm, cm, in, and pt.
Parameters
value - System.String
The value for PaperSize
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.PaperSize("A3"))
)
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 return the decoded file with the Content-Disposition header set to attachment; filename="<fileName.pdf>".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..
Parameters
value - System.String
The value for ProxyURL
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.ProxyURL(Url.Action("Index_Proxy", "Home")))
)
ProxyTarget(System.String)
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, set the proxy Content-Disposition header to inline; filename="<fileName.pdf>".
Parameters
value - System.String
The value for ProxyTarget
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.ProxyTarget("_blank"))
)
Subject(System.String)
Sets the subject of the PDF file.
Parameters
value - System.String
The value for Subject
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Subject("Food Orders"))
)
Title(System.String)
Sets the title of the PDF file.
Parameters
value - System.String
The value for Title
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Title("Food Orders"))
)
VCenter(System.Boolean)
Indicates whether to center the content vertically. For more information, refer to hCenter.
Parameters
value - System.Boolean
The value for VCenter
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.VCenter(true))
)
VCenter()
Indicates whether to center the content vertically. For more information, refer to hCenter.
RETURNS
Returns the current SpreadsheetPdfSettingsBuilder instance.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.VCenter(true))
)