Defines the page settings to be used when saving a page as a pdf file.

interface PageSettings {
    edgeBottom?: number;
    edgeLeft?: number;
    edgeRight?: number;
    edgeTop?: number;
    footerCenter?: string;
    footerLeft?: string;
    footerRight?: string;
    headerCenter?: string;
    headerLeft?: string;
    headerRight?: string;
    marginBottom?: number;
    marginLeft?: number;
    marginRight?: number;
    marginTop?: number;
    orientation?: number;
    paperHeight?: number;
    paperSizeUnit?: number;
    paperWidth?: number;
    scaling?: number;
    showBackgroundColors?: boolean;
    showBackgroundImages?: boolean;
    shrinkToFit?: boolean;
    toFileName?: string;
}
Index
edgeBottom?: number

The spacing between the bottom of the footers and the bottom edge of the paper (inches). Default: 0.

edgeLeft?: number

The spacing between the left header/footer and the left edge of the paper (inches). Default: 0.

edgeRight?: number

The spacing between the right header/footer and the right edge of the paper (inches). Default: 0.

edgeTop?: number

The spacing between the top of the headers and the top edge of the paper (inches). Default: 0

footerCenter?: string

The text for the page's center footer. Default: ''.

footerLeft?: string

The text for the page's left footer. Default: '&PT'.

footerRight?: string

The text for the page's right footer. Default: '&D'.

headerCenter?: string

The text for the page's center header. Default: ''.

headerLeft?: string

The text for the page's left header. Default: '&T'.

headerRight?: string

The text for the page's right header. Default: '&U'.

marginBottom?: number

The margin between the page content and the bottom edge of the paper (inches). Default: 0.5.

marginLeft?: number

The margin between the page content and the left edge of the paper (inches). Default: 0.5.

marginRight?: number

The margin between the page content and the right edge of the paper (inches). Default: 0.5.

marginTop?: number

The margin between the page content and the top edge of the paper (inches). Default: 0.5.

orientation?: number

The page content orientation: 0 = portrait, 1 = landscape. Default: 0.

paperHeight?: number

The paper height in paper size units. Default: 11.0.

paperSizeUnit?: number

The page size unit: 0 = inches, 1 = millimeters. Default: 0.

paperWidth?: number

The paper width in paper size units. Default: 8.5.

scaling?: number

The page content scaling factor: 1.0 = 100% = normal size. Default: 1.0.

showBackgroundColors?: boolean

Whether the page background colors should be shown. Default: false.

showBackgroundImages?: boolean

Whether the page background images should be shown. Default: false.

shrinkToFit?: boolean

Whether the page content should shrink to fit the page width (overrides scaling). Default: true.

toFileName?: string

The name of the file. May include optional .pdf extension.