TreeListPdfSettingsBuilder
Methods
AllPages(System.Boolean)
Exports all TreeList pages, starting from the first one.
Parameters
value - System.Boolean
The value for AllPages
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
AllPages()
Exports all TreeList pages, starting from the first one.
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
Author(System.String)
The author of the PDF document.
Parameters
value - System.String
The value for Author
RETURNS
Returns the current TreeListPdfSettingsBuilder 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 TreeListPdfSettingsBuilder instance.
AutoPrint()
Specifies if the Print dialog should be opened immediately after loading the document.
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
AvoidLinks(System.Boolean)
(Available as of the 2015.3.1020 release) A flag which indicates whether to produce actual hyperlinks in the exported PDF file. You can also pass a CSS selector as an argument. All matching links will be ignored.
Parameters
value - System.Boolean
The value for AvoidLinks
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
AvoidLinks()
(Available as of the 2015.3.1020 release) A flag which indicates whether to produce actual hyperlinks in the exported PDF file. You can also pass a CSS selector as an argument. All matching links will be ignored.
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
Creator(System.String)
The creator of the PDF document.
Parameters
value - System.String
The value for Creator
RETURNS
Returns the current TreeListPdfSettingsBuilder 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 TreeListPdfSettingsBuilder 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 TreeListPdfSettingsBuilder instance.
ForceProxy(System.Boolean)
If set to true, the content will be forwarded to proxyURL even if the browser supports the local saving of files.
Parameters
value - System.Boolean
The value for ForceProxy
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
ForceProxy()
If set to true, the content will be forwarded to proxyURL even if the browser supports the local saving of files.
RETURNS
Returns the current TreeListPdfSettingsBuilder 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 TreeListPdfSettingsBuilder 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 TreeListPdfSettingsBuilder instance.
KeepPNG()
If set to true all PNG images contained in the exported file will be kept in PNG format.
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
Keywords(System.String)
Specifies the keywords of the exported PDF file.
Parameters
value - System.String
The value for Keywords
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
Landscape(System.Boolean)
If set to true, reverses the paper dimensions in such a way that the width becomes the larger edge.
Parameters
value - System.Boolean
The value for Landscape
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
Landscape()
If set to true, reverses the paper dimensions in such a way that the width becomes the larger edge.
RETURNS
Returns the current TreeListPdfSettingsBuilder 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. Such browsers are IE version 9 and earlier, 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 TreeListPdfSettingsBuilder instance.
ProxyTarget(System.String)
A name or keyword whcih indicates where to display the document that was returned by the proxy. To display the document in a new window or iframe, the proxy will set the Content-Disposition header to inline; filename="<fileName.pdf>".
Parameters
value - System.String
The value for ProxyTarget
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
Subject(System.String)
Sets the subject of the PDF file.
Parameters
value - System.String
The value for Subject
RETURNS
Returns the current TreeListPdfSettingsBuilder instance.
Title(System.String)
Sets the title of the PDF file.
Parameters
value - System.String
The value for Title
RETURNS
Returns the current TreeListPdfSettingsBuilder 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.