ExcelScript.PageLayout interface

包:

ExcelScript

表示不依赖于任何打印机特定实现的布局和打印设置。 这些设置包括页边距、方向、页码编号、标题行，并打印区域。

注解

示例

/**
 * This script sets some basic page layout settings for printing.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout : ExcelScript.PageLayout = sheet.getPageLayout();

    // Turn off draft mode so images are printed.
    pageLayout.setDraftMode(false);
    
    // Print on 8.5"x11" paper.
    pageLayout.setPaperSize(ExcelScript.PaperType.letter);

    // Print every page with a landscape orientation.
    pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
  });
}

方法

getBlackAndWhite()	工作表的黑白打印选项。
getBottomMargin()	用于打印的工作表的下页边距（以磅为单位）。
getCenterHorizontally()	工作表的中心水平标记。 此标记确定在打印时是否水平居中工作表。
getCenterVertically()	工作表的中心垂直标志。 此标记确定在打印时是否垂直居中工作表。
getDraftMode()	工作表的草稿模式选项。 如果 true为 ，则打印工作表时将不带图形。
getFirstPageNumber()	要打印的工作表的第一页码。 值 null 表示“自动”页码。
getFooterMargin()	工作表的页脚边距（以磅为单位），以便在打印时使用。
getHeaderMargin()	工作表的页眉边距（以磅为单位），以便在打印时使用。
getHeadersFooters()	工作表的页眉和页脚配置。
getLeftMargin()	工作表的左边距（以磅为单位），以便在打印时使用。
getOrientation()	工作表的页面方向。
getPaperSize()	工作表的页面纸张大小。
getPrintArea()	RangeAreas获取对象，该对象包含一个或多个矩形区域，该矩形区域表示工作表的打印区域。 如果没有打印区域，则此方法返回 undefined。
getPrintComments()	指定打印时是否应显示工作表的批注。
getPrintErrors()	工作表的打印错误选项。
getPrintGridlines()	指定是否打印工作表的网格线。
getPrintHeadings()	指定是否打印工作表的标题。
getPrintOrder()	工作表的页面打印顺序选项。 它指定用于处理打印页码的顺序。
getPrintTitleColumns()	获取表示标题列的 Range 对象。 如果未设置，则此方法返回 undefined。
getPrintTitleRows()	获取表示标题行的 Range 对象。 如果未设置，则此方法返回 undefined。
getRightMargin()	工作表的右边距（以磅为单位），以便在打印时使用。
getTopMargin()	工作表的上边距（以磅为单位），以便在打印时使用。
getZoom()	工作表的打印缩放选项。 对象 PageLayoutZoomOptions 必须设置为 JSON 对象， (使用 x.zoom = {...} 而不是 x.zoom.scale = ...) 。
setBlackAndWhite(blackAndWhite)	工作表的黑白打印选项。
setBottomMargin(bottomMargin)	用于打印的工作表的下页边距（以磅为单位）。
setCenterHorizontally(centerHorizontally)	工作表的中心水平标记。 此标记确定在打印时是否水平居中工作表。
setCenterVertically(centerVertically)	工作表的中心垂直标志。 此标记确定在打印时是否垂直居中工作表。
setDraftMode(draftMode)	工作表的草稿模式选项。 如果 true为 ，则打印工作表时将不带图形。
setFirstPageNumber(firstPageNumber)	要打印的工作表的第一页码。 值 null 表示“自动”页码。
setFooterMargin(footerMargin)	工作表的页脚边距（以磅为单位），以便在打印时使用。
setHeaderMargin(headerMargin)	工作表的页眉边距（以磅为单位），以便在打印时使用。
setLeftMargin(leftMargin)	工作表的左边距（以磅为单位），以便在打印时使用。
setOrientation(orientation)	工作表的页面方向。
setPaperSize(paperSize)	工作表的页面纸张大小。
setPrintArea(printArea)	设置工作表的打印区域。
setPrintComments(printComments)	指定打印时是否应显示工作表的批注。
setPrintErrors(printErrors)	工作表的打印错误选项。
setPrintGridlines(printGridlines)	指定是否打印工作表的网格线。
setPrintHeadings(printHeadings)	指定是否打印工作表的标题。
setPrintMargins(unit, marginOptions)	设置带单位的工作表的页边距。
setPrintOrder(printOrder)	工作表的页面打印顺序选项。 它指定用于处理打印页码的顺序。
setPrintTitleColumns(printTitleColumns)	设置列，这些列包含要在打印的工作表的每页左侧重复的单元格。
setPrintTitleRows(printTitleRows)	设置行，这些行包含要在打印的工作表的每页顶部重复的单元格。
setRightMargin(rightMargin)	工作表的右边距（以磅为单位），以便在打印时使用。
setTopMargin(topMargin)	工作表的上边距（以磅为单位），以便在打印时使用。
setZoom(zoom)	工作表的打印缩放选项。 对象 PageLayoutZoomOptions 必须设置为 JSON 对象， (使用 x.zoom = {...} 而不是 x.zoom.scale = ...) 。

方法详细信息

getBlackAndWhite()

工作表的黑白打印选项。

getBlackAndWhite(): boolean;

返回

boolean

getBottomMargin()

用于打印的工作表的下页边距（以磅为单位）。

getBottomMargin(): number;

返回

number

getCenterHorizontally()

工作表的中心水平标记。 此标记确定在打印时是否水平居中工作表。

getCenterHorizontally(): boolean;

返回

boolean

getCenterVertically()

工作表的中心垂直标志。 此标记确定在打印时是否垂直居中工作表。

getCenterVertically(): boolean;

返回

boolean

getDraftMode()

工作表的草稿模式选项。 如果 true为 ，则打印工作表时将不带图形。

getDraftMode(): boolean;

返回

boolean

getFirstPageNumber()

要打印的工作表的第一页码。 值 null 表示“自动”页码。

getFirstPageNumber(): number | "";

返回

number | ""

getFooterMargin()

工作表的页脚边距（以磅为单位），以便在打印时使用。

getFooterMargin(): number;

返回

number

getHeaderMargin()

工作表的页眉边距（以磅为单位），以便在打印时使用。

getHeaderMargin(): number;

返回

number

getHeadersFooters()

工作表的页眉和页脚配置。

getHeadersFooters(): HeaderFooterGroup;

返回

ExcelScript.HeaderFooterGroup

getLeftMargin()

工作表的左边距（以磅为单位），以便在打印时使用。

getLeftMargin(): number;

返回

number

getOrientation()

工作表的页面方向。

getOrientation(): PageOrientation;

返回

ExcelScript.PageOrientation

getPaperSize()

工作表的页面纸张大小。

getPaperSize(): PaperType;

返回

ExcelScript.PaperType

getPrintArea()

RangeAreas获取对象，该对象包含一个或多个矩形区域，该矩形区域表示工作表的打印区域。 如果没有打印区域，则此方法返回 undefined。

getPrintArea(): RangeAreas;

返回

ExcelScript.RangeAreas

getPrintComments()

指定打印时是否应显示工作表的批注。

getPrintComments(): PrintComments;

返回

ExcelScript.PrintComments

getPrintErrors()

工作表的打印错误选项。

getPrintErrors(): PrintErrorType;

返回

ExcelScript.PrintErrorType

getPrintGridlines()

指定是否打印工作表的网格线。

getPrintGridlines(): boolean;

返回

boolean

getPrintHeadings()

指定是否打印工作表的标题。

getPrintHeadings(): boolean;

返回

boolean

getPrintOrder()

工作表的页面打印顺序选项。 它指定用于处理打印页码的顺序。

getPrintOrder(): PrintOrder;

返回

ExcelScript.PrintOrder

getPrintTitleColumns()

获取表示标题列的 Range 对象。 如果未设置，则此方法返回 undefined。

getPrintTitleColumns(): Range;

返回

ExcelScript.Range

getPrintTitleRows()

获取表示标题行的 Range 对象。 如果未设置，则此方法返回 undefined。

getPrintTitleRows(): Range;

返回

ExcelScript.Range

getRightMargin()

工作表的右边距（以磅为单位），以便在打印时使用。

getRightMargin(): number;

返回

number

getTopMargin()

工作表的上边距（以磅为单位），以便在打印时使用。

getTopMargin(): number;

返回

number

getZoom()

工作表的打印缩放选项。 对象 PageLayoutZoomOptions 必须设置为 JSON 对象， (使用 x.zoom = {...} 而不是 x.zoom.scale = ...) 。

getZoom(): PageLayoutZoomOptions;

返回

ExcelScript.PageLayoutZoomOptions

setBlackAndWhite(blackAndWhite)

工作表的黑白打印选项。

setBlackAndWhite(blackAndWhite: boolean): void;

参数

blackAndWhite

boolean

返回

void

setBottomMargin(bottomMargin)

用于打印的工作表的下页边距（以磅为单位）。

setBottomMargin(bottomMargin: number): void;

参数

bottomMargin

number

返回

void

setCenterHorizontally(centerHorizontally)

工作表的中心水平标记。 此标记确定在打印时是否水平居中工作表。

setCenterHorizontally(centerHorizontally: boolean): void;

参数

centerHorizontally

boolean

返回

void

setCenterVertically(centerVertically)

工作表的中心垂直标志。 此标记确定在打印时是否垂直居中工作表。

setCenterVertically(centerVertically: boolean): void;

参数

centerVertically

boolean

返回

void

setDraftMode(draftMode)

工作表的草稿模式选项。 如果 true为 ，则打印工作表时将不带图形。

setDraftMode(draftMode: boolean): void;

参数

draftMode

boolean

返回

void

示例

/**
 * This script turns off the print setting for draft mode.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();

    // Turn off draft mode so images are printed.
    pageLayout.setDraftMode(false);
  });
}

setFirstPageNumber(firstPageNumber)

要打印的工作表的第一页码。 值 null 表示“自动”页码。

setFirstPageNumber(firstPageNumber: number | ""): void;

参数

firstPageNumber

number | ""

返回

void

setFooterMargin(footerMargin)

工作表的页脚边距（以磅为单位），以便在打印时使用。

setFooterMargin(footerMargin: number): void;

参数

footerMargin

number

返回

void

setHeaderMargin(headerMargin)

工作表的页眉边距（以磅为单位），以便在打印时使用。

setHeaderMargin(headerMargin: number): void;

参数

headerMargin

number

返回

void

setLeftMargin(leftMargin)

工作表的左边距（以磅为单位），以便在打印时使用。

setLeftMargin(leftMargin: number): void;

参数

leftMargin

number

返回

void

setOrientation(orientation)

工作表的页面方向。

setOrientation(orientation: PageOrientation): void;

参数

orientation

ExcelScript.PageOrientation

返回

void

示例

/**
 * This script sets the printing orientation for the entire workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();

    // Print every page with a landscape orientation.
    pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
  });
}

setPaperSize(paperSize)

工作表的页面纸张大小。

setPaperSize(paperSize: PaperType): void;

参数

paperSize

ExcelScript.PaperType

返回

void

示例

/**
 * This script sets the page size for printing.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();
    // Print on 8.5"x11" paper.
    pageLayout.setPaperSize(ExcelScript.PaperType.letter);
  });
}

setPrintArea(printArea)

设置工作表的打印区域。

setPrintArea(printArea: Range | RangeAreas | string): void;

参数

printArea

ExcelScript.Range | ExcelScript.RangeAreas | string

要打印的内容的范围。

返回

void

setPrintComments(printComments)

指定打印时是否应显示工作表的批注。

setPrintComments(printComments: PrintComments): void;

参数

printComments

ExcelScript.PrintComments

返回

void

示例

/**
 * This script makes the comments print at the end of the worksheet
 * when the workbook is printed.
 */
function main(workbook: ExcelScript.Workbook) {
  // Access every worksheet in the workbook.
  workbook.getWorksheets().forEach(worksheet => {
    // Get the page layout for each sheet.
    const layout = worksheet.getPageLayout();

    // Change the comment printing settings to print them at the end of the sheet.
    layout.setPrintComments(ExcelScript.PrintComments.endSheet);
  });
}

setPrintErrors(printErrors)

工作表的打印错误选项。

setPrintErrors(printErrors: PrintErrorType): void;

参数

printErrors

ExcelScript.PrintErrorType

返回

void

setPrintGridlines(printGridlines)

指定是否打印工作表的网格线。

setPrintGridlines(printGridlines: boolean): void;

参数

printGridlines

boolean

返回

void

setPrintHeadings(printHeadings)

指定是否打印工作表的标题。

setPrintHeadings(printHeadings: boolean): void;

参数

printHeadings

boolean

返回

void

setPrintMargins(unit, marginOptions)

设置带单位的工作表的页边距。

setPrintMargins(
            unit: PrintMarginUnit,
            marginOptions: PageLayoutMarginOptions
        ): void;

参数

unit

ExcelScript.PrintMarginUnit

提供的边距的度量单位。

marginOptions

ExcelScript.PageLayoutMarginOptions

要设置的边距值。 未提供的边距保持不变。

返回

void

setPrintOrder(printOrder)

工作表的页面打印顺序选项。 它指定用于处理打印页码的顺序。

setPrintOrder(printOrder: PrintOrder): void;

参数

printOrder

ExcelScript.PrintOrder

返回

void

示例

/**
 * This script sets the print order for every worksheet in the workbook.
 * The order of printed content will go over (e.g., left-to-right) 
 * then down (i.e., top-to-bottom).
 */
function main(workbook: ExcelScript.Workbook) {
  // Access every worksheet in the workbook.
  workbook.getWorksheets().forEach(worksheet => {
    // Get the page layout for each sheet.
    const layout: ExcelScript.PageLayout = worksheet.getPageLayout();

    // Set the print order to over-then-down.
    layout.setPrintOrder(ExcelScript.PrintOrder.overThenDown);
  });
}

setPrintTitleColumns(printTitleColumns)

设置列，这些列包含要在打印的工作表的每页左侧重复的单元格。

setPrintTitleColumns(printTitleColumns: Range | string): void;

参数

printTitleColumns

ExcelScript.Range | string

要在每页左侧重复的列。 范围必须跨越整个列才能有效。

返回

void

setPrintTitleRows(printTitleRows)

设置行，这些行包含要在打印的工作表的每页顶部重复的单元格。

setPrintTitleRows(printTitleRows: Range | string): void;

参数

printTitleRows

ExcelScript.Range | string

要在每个页面顶部重复的行。 范围必须跨越整行才能有效。

返回

void

setRightMargin(rightMargin)

工作表的右边距（以磅为单位），以便在打印时使用。

setRightMargin(rightMargin: number): void;

参数

rightMargin

number

返回

void

setTopMargin(topMargin)

工作表的上边距（以磅为单位），以便在打印时使用。

setTopMargin(topMargin: number): void;

参数

topMargin

number

返回

void

setZoom(zoom)

工作表的打印缩放选项。 对象 PageLayoutZoomOptions 必须设置为 JSON 对象， (使用 x.zoom = {...} 而不是 x.zoom.scale = ...) 。

setZoom(zoom: PageLayoutZoomOptions): void;

参数

zoom

ExcelScript.PageLayoutZoomOptions

返回

void

示例

/**
 * This script changes the scale-to-fit of the page layout.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the current worksheet.
    const sheet = workbook.getActiveWorksheet();

    // Scale the layout to half size for printing.
    const layout = sheet.getPageLayout();
    const zoomOptions: ExcelScript.PageLayoutZoomOptions = {
        scale: 50
    }
    layout.setZoom(zoomOptions)
}