GridPdfSettingsBuilder
Methods
AllPages(System.Boolean)
Exports all grid pages, starting from the first one.
Parameters
value - System.Boolean
The value for AllPages
RETURNS
Returns the current GridPdfSettingsBuilder instance.
AllPages()
Exports all grid pages, starting from the first one.
RETURNS
Returns the current GridPdfSettingsBuilder instance.
Author(System.String)
The author of the PDF document.
Parameters
value - System.String
The value for Author
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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 GridPdfSettingsBuilder instance.
AutoPrint()
Specifies if the Print dialog should be opened immediately after loading the document.
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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.
RETURNS
Returns the current GridPdfSettingsBuilder instance.
Creator(System.String)
The creator of the PDF document.
Parameters
value - System.String
The value for Creator
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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 GridPdfSettingsBuilder instance.
FileName(System.String)
Specifies the file name of the exported PDF file.
Parameters
value - System.String
The value for FileName
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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
RETURNS
Returns the current GridPdfSettingsBuilder instance.
ForceProxy()
If set to true, the content will be forwarded to proxyURL even if the browser supports saving files locally.
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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 GridPdfSettingsBuilder instance.
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 GridPdfSettingsBuilder instance.
KeepPNG()
If set to true all PNG images contained in the exported file will be kept in PNG format.
RETURNS
Returns the current GridPdfSettingsBuilder instance.
Keywords(System.String)
Specifies the keywords of the exported PDF file.
Parameters
value - System.String
The value for Keywords
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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
RETURNS
Returns the current GridPdfSettingsBuilder instance.
Landscape()
Set to true to reverse the paper dimensions if needed such that width is the larger edge.
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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
RETURNS
Returns the current GridPdfSettingsBuilder instance.
TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
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
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for Template
RETURNS
Returns the current GridPdfSettingsBuilder instance.
TemplateHandler(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
templateHandler - System.String
The handler that returs the template for Template
RETURNS
Returns the current GridPdfSettingsBuilder instance.
Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)
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
template - TemplateBuilder<TModel>
A Template component that configures the template.
RETURNS
Returns the current GridPdfSettingsBuilder instance.
RepeatHeaders(System.Boolean)
Set this to true to repeat the grid headers on each page.
Parameters
value - System.Boolean
The value for RepeatHeaders
RETURNS
Returns the current GridPdfSettingsBuilder instance.
RepeatHeaders()
Set this to true to repeat the grid headers on each page.
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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
RETURNS
Returns the current GridPdfSettingsBuilder instance.
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
RETURNS
Returns the current GridPdfSettingsBuilder instance.
Subject(System.String)
Sets the subject of the PDF file.
Parameters
value - System.String
The value for Subject
RETURNS
Returns the current GridPdfSettingsBuilder instance.
Title(System.String)
Sets the title of the PDF file.
Parameters
value - System.String
The value for Title
RETURNS
Returns the current GridPdfSettingsBuilder instance.
PaperSize(System.String)
Specifies a predefiend paper size e.g. "A3", "A4" or "auto" (default).
Parameters
paperSize - System.String
RETURNS
Returns the current instance for method chaining.
PaperSize(System.Double,System.Double)
Specifies custom paper size in "pt" units.
Parameters
width - System.Double
height - System.Double
RETURNS
Returns the current instance for method chaining.
PaperSize(System.String,System.String)
Specifies custom paper size in custom units ("in", "mm", "pt", "cm")
Parameters
width - System.String
height - System.String
RETURNS
Returns the current instance for method chaining.
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
RETURNS
Returns the current instance for method chaining.
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
RETURNS
Returns the current instance for method chaining.
ForcePageBreak(System.String)
Specifies the forcePageBreak selector.
Parameters
selector - System.String
RETURNS
Returns the current instance for method chaining.