PDFSettingsBuilder
The fluent API for configuring the grid PDF export.
Definition
Namespace:Kendo.Mvc.UI.Fluent
Assembly:Kendo.Mvc.dll
Syntax:
public class PDFSettingsBuilder
Inheritance: objectPDFSettingsBuilder
Inherited Members
Constructors
Methods
Exports all pages. Applicable only for the Grid. Ajax binding or server binding with ServerOperation(false) is required.
Sets the author of the PDF document.
public PDFSettingsBuilder Author(string author)
The author of the PDF document.
Returns:Specifies if the Print dialog should be opened immediately after loading the document.
public PDFSettingsBuilder AutoPrint(bool value)
The value that configures the autoprint.
Returns:Does not create clickable hyperlinks in the exported PDF file.
A flag indicating whether to produce clickable hyperlinks in the exported PDF file.
public PDFSettingsBuilder AvoidLinks(bool avoidLinks)
A flag indicating whether to produce actual hyperlinks in the exported PDF file.
Returns:A CSS selector for the links to ignore. All matching links will not be clickable in the exported PDF file.
public PDFSettingsBuilder AvoidLinks(string avoidLinks)
A CSS class parameter. All matching links will not be clickable in the exported PDF file.
Returns:Sets the creator of the PDF document.
public PDFSettingsBuilder Creator(string creator)
The creator of the PDF document.
Returns:Sets the date of the PDF document.
public PDFSettingsBuilder Date(DateTime date)
The date when the PDF document is created.
Returns:Sets the file name of the PDF file.
public PDFSettingsBuilder FileName(string fileName)
Specifies the file name of the exported PDF file.
Returns:Sets the author of the PDF document.
public PDFSettingsBuilder ForcePageBreak(string selector)
The selector which will force the pages to break in the PDF document.
Returns:Forces the use of server-side proxy even if the browser supports local saving.
public PDFSettingsBuilder ForceProxy(bool forceProxy)
true if the server proxy should be used always; false for automatic detection
Returns:Specifies the quality of the images within the exported file, from 0 to 1.
public PDFSettingsBuilder JpegQuality(double value)
The value that configures the jpegquality.
Returns:If set to true all PNG images contained in the exported file will be kept in PNG format.
public PDFSettingsBuilder KeepPNG(bool value)
The value that configures the keeppng.
Returns:Sets the keywords of the PDF document.
public PDFSettingsBuilder Keywords(string keywords)
Specifies the keywords of the exported PDF file.
Returns:Turns the page in landscape orientation.
Specifies the margins in "pt" units.
public PDFSettingsBuilder Margin(double top, double right, double bottom, double left)
Specifies the top margin in "pt" units.
rightdoubleSpecifies the right margin in "pt" units.
bottomdoubleSpecifies the bottom margin in "pt" units.
leftdoubleSpecifies the left margin in "pt" units.
Returns:Specifies the margins in units ("in", "mm", "pt", "cm")
Specifies a predefiend paper size e.g. "A3", "A4" or "auto" (default).
public PDFSettingsBuilder PaperSize(string paperSize)
Specifies the paper size.
Returns:Set the a name or keyword indicating where to display the document returned from the proxy. The default is "_self".
public PDFSettingsBuilder ProxyTarget(string target)
The proxy target
Returns:Set the url of the server side proxy. The proxy is responsible for returning the PDF to the end user. Used in browsers that don't support saving files from JavaScript.
public PDFSettingsBuilder ProxyURL(string url)
The URL of the server side proxy which will stream the file to the end user.
Returns:Set this to true to repeat the grid headers on each page.
Set this to true to repeat the grid headers on each page.
public PDFSettingsBuilder RepeatHeaders(bool value)
The value for RepeatHeaders
Returns: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.
public PDFSettingsBuilder Scale(double scale)
The value for the scale factor.
Returns:Sets the subject of the PDF document.
public PDFSettingsBuilder Subject(string subject)
The subject value of the PDF file.
Returns:A piece of HTML to be included in each page. Can be used to display headers and footers. See the documentation in drawDOM.
public PDFSettingsBuilder Template<TModel>(TemplateBuilder<TModel> template)
A Template component that configures the template.
Returns:A piece of HTML to be included in each page. Can be used to display headers and footers. See the documentation in drawDOM.
public PDFSettingsBuilder TemplateId(string templateId)
The ID of the template element for Template
Returns:A piece of HTML to be included in each page. Can be used to display headers and footers. See the documentation in drawDOM.
public PDFSettingsBuilder TemplateView(MvcHtmlString templateView)
The view that contains Template
Returns:Sets the title of the PDF document.
public PDFSettingsBuilder Title(string title)
The title of the PDF file.
Returns: