New to Telerik UI for ASP.NET Core? Download free 30-day trial

GridPdfSettingsBuilder

Defines the fluent API for configuring GridPdfSettings

Methods

AllPages(System.Boolean)

Exports all grid pages, starting from the first one.

Parameters

value - System.Boolean

The value for AllPages

AllPages()

Exports all grid pages, starting from the first one.

Author(System.String)

The author of the PDF document.

Parameters

value - System.String

The value for Author

AutoPrint(System.Boolean)

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

Parameters

value - System.Boolean

The value for AutoPrint

AutoPrint()

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

AvoidLinks(System.Boolean)

A flag indicating whether to produce actual hyperlinks in the exported PDF file.It's also possible to pass a CSS selector as argument. All matching links will be ignored.

Parameters

value - System.Boolean

The value for AvoidLinks

A flag indicating whether to produce actual hyperlinks in the exported PDF file.It's also possible to pass a CSS selector as argument. All matching links will be ignored.

Creator(System.String)

The creator of the PDF document.

Parameters

value - System.String

The value for Creator

Date(System.DateTime)

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

Parameters

value - System.DateTime

The value for Date

FileName(System.String)

Specifies the file name of the exported PDF file.

Parameters

value - System.String

The value for FileName

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 for ForceProxy

ForceProxy()

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

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

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

KeepPNG()

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

Keywords(System.String)

Specifies the keywords of the exported PDF file.

Parameters

value - System.String

The value for 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 for Landscape

Landscape()

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

Template(System.String)

A piece of HTML to be included in each page. Can be used to display headers and footers. See the documentation in drawDOM.Available template variables include: * pageNum * totalPages

Parameters

value - System.String

The value for Template

TemplateId(System.String)

A piece of HTML to be included in each page. Can be used to display headers and footers. See the documentation in drawDOM.Available template variables include: * pageNum * totalPages

Parameters

templateId - System.String

The ID of the template element for Template

RepeatHeaders(System.Boolean)

Set this to true to repeat the grid headers on each page.

Parameters

value - System.Boolean

The value for RepeatHeaders

RepeatHeaders()

Set this to true to repeat the grid headers on each page.

Scale(System.Double)

A scale factor. In many cases, text size on screen will be too big for print, so you can use this option to scale down the output in PDF. See the documentation in drawDOM.

Parameters

value - System.Double

The value for Scale

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

Parameters

value - System.String

The value for 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="<fileName.pdf>".

Parameters

value - System.String

The value for ProxyTarget

Subject(System.String)

Sets the subject of the PDF file.

Parameters

value - System.String

The value for Subject

Title(System.String)

Sets the title of the PDF file.

Parameters

value - System.String

The value for Title

PaperSize(System.String)

Specifies a predefiend paper size e.g. "A3", "A4" or "auto" (default).

Parameters

paperSize - System.String

PaperSize(System.Double,System.Double)

Specifies custom paper size in "pt" units.

Parameters

width - System.Double
height - System.Double

PaperSize(System.String,System.String)

Specifies custom paper size in custom units ("in", "mm", "pt", "cm")

Parameters

width - System.String
height - System.String

Margin(System.Double,System.Double,System.Double,System.Double)

Specifies the margins in "pt" units.

Parameters

top - System.Double
right - System.Double
bottom - System.Double
left - System.Double

Margin(System.String,System.String,System.String,System.String)

Specifies the margins in units ("in", "mm", "pt", "cm")

Parameters

top - System.String
right - System.String
bottom - System.String
left - System.String
In this article
Not finding the help you need?