Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / SpreadsheetPdfSettingsBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

SpreadsheetPdfSettingsBuilder

Class

Defines the fluent API for configuring the SpreadsheetPdfSettings settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class SpreadsheetPdfSettingsBuilder

Inheritance: objectSpreadsheetPdfSettingsBuilder

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

SpreadsheetPdfSettingsBuilder(SpreadsheetPdfSettings)

C#
public SpreadsheetPdfSettingsBuilder(SpreadsheetPdfSettings settings)
Parameters:settingsSpreadsheetPdfSettings

Methods

Area(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.

C#
public SpreadsheetPdfSettingsBuilder Area(string value)
Parameters:valuestring

The value that configures the area.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Area("selection"))
)

Author(string)

The author of the PDF document.

C#
public SpreadsheetPdfSettingsBuilder Author(string value)
Parameters:valuestring

The value that configures the author.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Author("John Doe"))
)

AutoPrint(bool)

Specifies if the Print dialog should be opened immediately after loading the document.

C#
public SpreadsheetPdfSettingsBuilder AutoPrint(bool value)
Parameters:valuebool

The value that configures the autoprint.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.AutoPrint(true))
)

Creator(string)

The creator of the PDF document.

C#
public SpreadsheetPdfSettingsBuilder Creator(string value)
Parameters:valuestring

The value that configures the creator.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Creator("John Doe"))
)

Date(DateTime)

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

C#
public SpreadsheetPdfSettingsBuilder Date(DateTime value)
Parameters:valueDateTime

The value that configures the date.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Date(DateTime.Now))
)

FileName(string)

Specifies the file name of the exported PDF file.

C#
public SpreadsheetPdfSettingsBuilder FileName(string value)
Parameters:valuestring

The value that configures the filename.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.FileName("Sheet1.pdf"))
)

FitWidth(bool)

Indicates whether to fit the content of the Spreadsheet to the width of the page.

C#
public SpreadsheetPdfSettingsBuilder FitWidth(bool value)
Parameters:valuebool

The value that configures the fitwidth.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.FitWidth(true))
)

ForceProxy(bool)

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

C#
public SpreadsheetPdfSettingsBuilder ForceProxy(bool value)
Parameters:valuebool

The value that configures the forceproxy.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.ForceProxy(true))
)

Guidelines(bool)

Indicates whether to export the cell guidelines.

C#
public SpreadsheetPdfSettingsBuilder Guidelines(bool value)
Parameters:valuebool

The value that configures the guidelines.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Guidelines(true))
)

HCenter(bool)

Indicates whether to center the content horizontally. For more information, refer to vCenter.

C#
public SpreadsheetPdfSettingsBuilder HCenter(bool value)
Parameters:valuebool

The value that configures the hcenter.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.HCenter(true))
)

JpegQuality(double)

Specifies the quality of the images within the exported file, from 0 to 1.

C#
public SpreadsheetPdfSettingsBuilder JpegQuality(double value)
Parameters:valuedouble

The value that configures the jpegquality.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.JpegQuality(1))
)

KeepPNG(bool)

If set to true all PNG images contained in the exported file will be kept in PNG format.

C#
public SpreadsheetPdfSettingsBuilder KeepPNG(bool value)
Parameters:valuebool

The value that configures the keeppng.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.KeepPNG(true))
)

Keywords(string)

Specifies the keywords of the exported PDF file.

C#
public SpreadsheetPdfSettingsBuilder Keywords(string value)
Parameters:valuestring

The value that configures the keywords.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Keywords("food order"))
)

Landscape(bool)

If set to true, reverses the paper dimensions if that width is needed as the larger edge.

C#
public SpreadsheetPdfSettingsBuilder Landscape(bool value)
Parameters:valuebool

The value that configures the landscape.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf.Landscape(true))
)

Margin(Action<SpreadsheetPdfMarginSettingsBuilder>)

Specifies the margins of the page (numbers or strings with units).The supported values are: mm; cm; in or pt (default).

C#
public SpreadsheetPdfSettingsBuilder Margin(Action<SpreadsheetPdfMarginSettingsBuilder> configurator)
Parameters:configuratorAction<SpreadsheetPdfMarginSettingsBuilder>

The action that configures the margin.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf =&gt; pdf.Margin(margin =&gt; margin.Top(50)))
)

PaperSize(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.

C#
public SpreadsheetPdfSettingsBuilder PaperSize(string value)
Parameters:valuestring

The value that configures the papersize.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf =&gt; pdf.PaperSize("A3"))
)

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

C#
public SpreadsheetPdfSettingsBuilder ProxyTarget(string value)
Parameters:valuestring

The value that configures the proxytarget.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf =&gt; pdf.ProxyTarget("_blank"))
)

ProxyURL(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..

C#
public SpreadsheetPdfSettingsBuilder ProxyURL(string value)
Parameters:valuestring

The value that configures the proxyurl.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf =&gt; pdf.ProxyURL(Url.Action("Index_Proxy", "Home")))
)

Subject(string)

Sets the subject of the PDF file.

C#
public SpreadsheetPdfSettingsBuilder Subject(string value)
Parameters:valuestring

The value that configures the subject.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf =&gt; pdf.Subject("Food Orders"))
)

Title(string)

Sets the title of the PDF file.

C#
public SpreadsheetPdfSettingsBuilder Title(string value)
Parameters:valuestring

The value that configures the title.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf =&gt; pdf.Title("Food Orders"))
)

VCenter(bool)

Indicates whether to center the content vertically. For more information, refer to hCenter.

C#
public SpreadsheetPdfSettingsBuilder VCenter(bool value)
Parameters:valuebool

The value that configures the vcenter.

Returns:

SpreadsheetPdfSettingsBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf =&gt; pdf.VCenter(true))
)
In this article
DefinitionConstructorsSpreadsheetPdfSettingsBuilder(SpreadsheetPdfSettings)MethodsArea(string)Author(string)AutoPrint(bool)Creator(string)Date(DateTime)FileName(string)FitWidth(bool)ForceProxy(bool)Guidelines(bool)HCenter(bool)JpegQuality(double)KeepPNG(bool)Keywords(string)Landscape(bool)Margin(Action<SpreadsheetPdfMarginSettingsBuilder>)PaperSize(string)ProxyTarget(string)ProxyURL(string)Subject(string)Title(string)VCenter(bool)
Not finding the help you need?
Contact Support