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)

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)
}

Поделиться через

ExcelScript.PageLayout interface

Комментарии

Примеры

Методы

Сведения о методе

getBlackAndWhite()

Возвращаемое значение

getBottomMargin()

Возвращаемое значение

getCenterHorizontally()

Возвращаемое значение

getCenterVertically()

Возвращаемое значение

getDraftMode()

Возвращаемое значение

getFirstPageNumber()

Возвращаемое значение

getFooterMargin()

Возвращаемое значение

getHeaderMargin()

Возвращаемое значение

getHeadersFooters()

Возвращаемое значение

getLeftMargin()

Возвращаемое значение

getOrientation()

Возвращаемое значение

getPaperSize()

Возвращаемое значение

getPrintArea()

Возвращаемое значение

getPrintComments()

Возвращаемое значение

getPrintErrors()

Возвращаемое значение

getPrintGridlines()

Возвращаемое значение

getPrintHeadings()

Возвращаемое значение

getPrintOrder()

Возвращаемое значение

getPrintTitleColumns()

Возвращаемое значение

getPrintTitleRows()

Возвращаемое значение

getRightMargin()

Возвращаемое значение

getTopMargin()

Возвращаемое значение

getZoom()

Возвращаемое значение

setBlackAndWhite(blackAndWhite)

Параметры

Возвращаемое значение

setBottomMargin(bottomMargin)

Параметры

Возвращаемое значение

setCenterHorizontally(centerHorizontally)

Параметры

Возвращаемое значение

setCenterVertically(centerVertically)

Параметры

Возвращаемое значение

setDraftMode(draftMode)

Параметры

Возвращаемое значение

Примеры

setFirstPageNumber(firstPageNumber)

Параметры

Возвращаемое значение

setFooterMargin(footerMargin)

Параметры

Возвращаемое значение

setHeaderMargin(headerMargin)

Параметры

Возвращаемое значение

setLeftMargin(leftMargin)

Параметры

Возвращаемое значение