SpreadsheetPdfSettingsBuilder

Methods

Area(System.String)

The area that will be exported.The supported values are: * workbook - Exports the full workbook, including all sheets. * sheet - Exports the active sheet. * selection - Exports the selected area on the active sheet.

Parameters

value - `System.String`

The value for Area

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

Author(System.String)

The author of the PDF document.

Parameters

value - `System.String`

The value for Author

RETURNS

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

AutoPrint()

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

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

Creator(System.String)

The creator of the PDF document.

Parameters

value - `System.String`

The value for Creator

RETURNS

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

FitWidth(System.Boolean)

Indicates whether to fit the content of the Spreadsheet to the width of the page.

Parameters

value - `System.Boolean`

The value for FitWidth

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

FitWidth()

Indicates whether to fit the content of the Spreadsheet to the width of the page.

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

ForceProxy(System.Boolean)

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

Parameters

value - `System.Boolean`

The value for ForceProxy

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

ForceProxy()

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

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

Guidelines(System.Boolean)

Indicates whether to export the cell guidelines.

Parameters

value - `System.Boolean`

The value for Guidelines

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

Guidelines()

Indicates whether to export the cell guidelines.

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

HCenter(System.Boolean)

Indicates whether to center the content horizontally. For more information, refer to vCenter.

Parameters

value - `System.Boolean`

The value for HCenter

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

HCenter()

Indicates whether to center the content horizontally. For more information, refer to vCenter.

RETURNS

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

KeepPNG()

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

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

Keywords(System.String)

Specifies the keywords of the exported PDF file.

Parameters

value - `System.String`

The value for Keywords

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

Landscape(System.Boolean)

If set to true, reverses the paper dimensions if that width is needed as the larger edge.

Parameters

value - `System.Boolean`

The value for Landscape

RETURNS

Returns the current SpreadsheetPdfSettingsBuilder instance.

Margin(System.Action)

Specifies the margins of the page (numbers or strings with units).The supported values are: mm; cm; in or pt (default).

Parameters

configurator - System.Action<SpreadsheetPdfMarginSettingsBuilder>

The configurator for the margin setting.

RETURNS

Returns the current instance of SpreadsheetPdfSettingsBuilder .

PaperSize(System.String)

Specifies the paper size of the PDF document. The default auto setting means that the paper size is determined by the content.The supported values are: * A predefined size - A4, A3, and so on. * An array of two numbers which specify the width and height in points (1pt = 1/72in). * An array of two strings which specify the width and height in units. The supported values are mm, cm, in, and pt.

Parameters

value - `System.String`

The value for PaperSize

RETURNS

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