PivotGridV2PdfSettingsBuilder

Methods

Author(System.String)

The author of the PDF document.

Parameters

value - System.String

The value for Author

RETURNS

Returns the current PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder instance.

AutoPrint()

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

RETURNS

Returns the current PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder instance.

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 PivotGridV2PdfSettingsBuilder instance.

Creator(System.String)

The creator of the PDF document.

Parameters

value - System.String

The value for Creator

RETURNS

Returns the current PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder instance.

KeepPNG()

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

RETURNS

Returns the current PivotGridV2PdfSettingsBuilder instance.

Keywords(System.String)

Specifies the keywords of the exported PDF file.

Parameters

value - System.String

The value for Keywords

RETURNS

Returns the current PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder instance.

Landscape()

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

RETURNS

Returns the current PivotGridV2PdfSettingsBuilder instance.

Margin(System.Action)

Specifies the margins of the page (numbers or strings with units). Supported units are "mm", "cm", "in" and "pt" (default).

Parameters

configurator - System.Action<PivotGridV2PdfMarginSettingsBuilder>

The configurator for the margin setting.

RETURNS

Returns the current instance of PivotGridV2PdfSettingsBuilder .

PaperSize(System.String)

Specifies the paper size of the PDF document. The default "auto" means paper size is determined by content.Supported values: A predefined size: "A4", "A3" etc; An array of two numbers specifying the width and height in points (1pt = 1/72in) or An array of two strings specifying the width and height in units. Supported units are "mm", "cm", "in" and "pt"..

Parameters

value - System.String

The value for PaperSize

RETURNS

Returns the current PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder 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 PivotGridV2PdfSettingsBuilder instance.

Subject(System.String)

Sets the subject of the PDF file.

Parameters

value - System.String

The value for Subject

RETURNS

Returns the current PivotGridV2PdfSettingsBuilder instance.

Title(System.String)

Sets the title of the PDF file.

Parameters

value - System.String

The value for Title

RETURNS

Returns the current PivotGridV2PdfSettingsBuilder instance.