PrintOptionsBase

Base class which exposes the various print options available for a sheet which can be saved with both a sheet and its custom view.

Constructors

new PrintOptionsBase(a: Sheet, b: boolean): PrintOptionsBase

Returns PrintOptionsBase

Properties

$t

$t: Type

Accessors

alignHeadersAndFootersWithMargins

Gets or sets the value indicating whether to align header and footer margins with page margins.

get alignHeadersAndFootersWithMargins(): boolean

Returns boolean

set alignHeadersAndFootersWithMargins(a: boolean): void

Parameters

a: boolean

Returns void

bottomMargin

Gets or sets the margin at the bottom of each printed page of the worksheet, specified in inches. The margin at the bottom of each printed page of the worksheet, specified in inches.

get bottomMargin(): number

Returns number

set bottomMargin(a: number): void

Parameters

a: number

Returns void

draftQuality

Gets or sets the value indicating whether the printed pages should be printed using draft quality. The value indicating whether the printed pages should be printed using draft quality.

get draftQuality(): boolean

Returns boolean

set draftQuality(a: boolean): void

Parameters

a: boolean

Returns void

Gets or sets the footer for each page of the printed worksheet.

get footer(): string

Returns string

set footer(a: string): void

Parameters

a: string

Returns void

footerMargin

Gets or sets the footer margin for each printed page of the worksheet, specified in inches. The footer margin for each printed page of the worksheet, specified in inches.

get footerMargin(): number

Returns number

set footerMargin(a: number): void

Parameters

a: number

Returns void

Gets or sets the header for each page of the printed worksheet.

get header(): string

Returns string

set header(a: string): void

Parameters

a: string

Returns void

headerMargin

Gets or sets the header margin for each printed page of the worksheet, specified in inches. The header margin for each printed page of the worksheet, specified in inches.

get headerMargin(): number

Returns number

set headerMargin(a: number): void

Parameters

a: number

Returns void

leftMargin

Gets or sets the margin at the left of each printed page of the worksheet, specified in inches. The margin at the left of each printed page of the worksheet, specified in inches.

get leftMargin(): number

Returns number

set leftMargin(a: number): void

Parameters

a: number

Returns void

numberOfCopies

Gets or sets the number of copies to print. The number of copies to print.

get numberOfCopies(): number

Returns number

set numberOfCopies(a: number): void

Parameters

a: number

Returns void

orientation

Gets or sets the orientation for each page of the printed worksheet. The orientation for each page of the printed worksheet.

get orientation(): Orientation

Returns Orientation

set orientation(a: Orientation): void

Parameters

a: Orientation

Returns void

orientationResolved

Returns the resolved orientation for each page of the printed worksheet.

get orientationResolved(): Orientation

Returns Orientation

pageNumbering

Gets or sets the method with which pages are numbered.

get pageNumbering(): PageNumbering

Returns PageNumbering

set pageNumbering(a: PageNumbering): void

Parameters

a: PageNumbering

Returns void

paperSize

Gets or sets the paper size for each printed page of the worksheet. The paper size for each printed page of the worksheet.

get paperSize(): PaperSize

Returns PaperSize

set paperSize(a: PaperSize): void

Parameters

a: PaperSize

Returns void

printErrors

Gets or sets the way error values of cells are printed.

get printErrors(): PrintErrors

Returns PrintErrors

set printErrors(a: PrintErrors): void

Parameters

a: PrintErrors

Returns void

printInBlackAndWhite

Gets or sets the value indicating whether the worksheet should be printed in black and white. The value indicating whether the worksheet should be printed in black and white.

get printInBlackAndWhite(): boolean

Returns boolean

set printInBlackAndWhite(a: boolean): void

Parameters

a: boolean

Returns void

printNotes

Gets or sets the way cell comments are printed.

get printNotes(): PrintNotes

Returns PrintNotes

set printNotes(a: PrintNotes): void

Parameters

a: PrintNotes

Returns void

resolution

Gets or sets the horizontal print resolution in DPI. The horizontal print resolution in DPI.

get resolution(): number

Returns number

set resolution(a: number): void

Parameters

a: number

Returns void

rightMargin

Gets or sets the margin at the right of each printed page of the worksheet, specified in inches. The margin at the right of each printed page of the worksheet, specified in inches.

get rightMargin(): number

Returns number

set rightMargin(a: number): void

Parameters

a: number

Returns void

scaleHeadersAndFootersWithDocument

Gets or sets the value indicating whether to scale the headers and footers with the document scaling.

get scaleHeadersAndFootersWithDocument(): boolean

Returns boolean

set scaleHeadersAndFootersWithDocument(a: boolean): void

Parameters

a: boolean

Returns void

startPageNumber

Gets or sets the page number for the first printed page of the worksheet.

get startPageNumber(): number

Returns number

set startPageNumber(a: number): void

Parameters

a: number

Returns void

topMargin

Gets or sets the margin at the top of each printed page of the worksheet, specified in inches. The margin at the top of each printed page of the worksheet, specified in inches.

get topMargin(): number

Returns number

set topMargin(a: number): void

Parameters

a: number

Returns void

verticalResolution

Gets or sets the vertical print resolution in DPI. The vertical print resolution in DPI.

get verticalResolution(): number

Returns number

set verticalResolution(a: number): void

Parameters

a: number

Returns void

Methods

reset

Resets the print options to their default settings.

reset(): void

Constructors