ExcelScript.PageLayout interface

A opção de impressão em preto e branco da planilha.

getBlackAndWhite(): boolean;

Retornos

A margem da página inferior da planilha a ser usada para imprimir em pontos.

getBottomMargin(): number;

Retornos

O sinalizador horizontal central da planilha. Esse sinalizador determina se a planilha será centralizada horizontalmente quando for impressa.

getCenterHorizontally(): boolean;

Retornos

O sinalizador vertical centralizado da planilha. Esse sinalizador determina se a planilha será centralizada verticalmente quando for impressa.

getCenterVertically(): boolean;

Retornos

A opção de modo de rascunho da planilha. Se true, a folha será impressa sem gráficos.

getDraftMode(): boolean;

Retornos

O primeiro número de página da planilha a ser impressa. Um null valor representa a numeração de página "automática".

getFirstPageNumber(): number | "";

Retornos

A margem do rodapé da planilha, em pontos, para uso na impressão.

getFooterMargin(): number;

Retornos

A margem do cabeçalho da planilha, em pontos, para uso durante a impressão.

getHeaderMargin(): number;

Retornos

Configuração de cabeçalho e rodapé da planilha.

getHeadersFooters(): HeaderFooterGroup;

Retornos

A margem esquerda da planilha, em pontos, para uso durante a impressão.

getLeftMargin(): number;

Retornos

A orientação da planilha da página.

getOrientation(): PageOrientation;

Retornos

O tamanho do papel da planilha da página.

getPaperSize(): PaperType;

Retornos

Obtém o RangeAreas objeto, compreendendo um ou mais intervalos retangulares, que representa a área de impressão da planilha. Se não houver área de impressão, esse método retornará undefined.

getPrintArea(): RangeAreas;

Retornos

Especifica se os comentários da planilha devem ser exibidos durante a impressão.

getPrintComments(): PrintComments;

Retornos

A opção de erros de impressão da planilha.

getPrintErrors(): PrintErrorType;

Retornos

Especifica se as linhas de grade da planilha serão impressas.

getPrintGridlines(): boolean;

Retornos

Especifica se os títulos da planilha serão impressos.

getPrintHeadings(): boolean;

Retornos

A opção de ordem de impressão de página da planilha. Isso especifica a ordem que será usada para processar o número de página impresso.

getPrintOrder(): PrintOrder;

Retornos

Obtém o objeto range que representa as colunas de título. Se não for definido, esse método retornará undefined.

getPrintTitleColumns(): Range;

Retornos

Obtém o objeto range representando as linhas do título. Se não for definido, esse método retornará undefined.

getPrintTitleRows(): Range;

Retornos

A margem direita da planilha, em pontos, para uso durante a impressão.

getRightMargin(): number;

Retornos

A margem superior da planilha, em pontos, para uso durante a impressão.

getTopMargin(): number;

Retornos

As opções de zoom de impressão da planilha. O PageLayoutZoomOptions objeto deve ser definido como um objeto JSON (use x.zoom = {...} em vez de x.zoom.scale = ...).

getZoom(): PageLayoutZoomOptions;

Retornos

A opção de impressão em preto e branco da planilha.

setBlackAndWhite(blackAndWhite: boolean): void;

Parâmetros

Retornos

A margem da página inferior da planilha a ser usada para imprimir em pontos.

setBottomMargin(bottomMargin: number): void;

Parâmetros

Retornos

O sinalizador horizontal central da planilha. Esse sinalizador determina se a planilha será centralizada horizontalmente quando for impressa.

setCenterHorizontally(centerHorizontally: boolean): void;

Parâmetros

Retornos

O sinalizador vertical centralizado da planilha. Esse sinalizador determina se a planilha será centralizada verticalmente quando for impressa.

setCenterVertically(centerVertically: boolean): void;

Parâmetros

Retornos

A opção de modo de rascunho da planilha. Se true, a folha será impressa sem gráficos.

setDraftMode(draftMode: boolean): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
  });
}

O primeiro número de página da planilha a ser impressa. Um null valor representa a numeração de página "automática".

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

Parâmetros

Retornos

A margem do rodapé da planilha, em pontos, para uso na impressão.

setFooterMargin(footerMargin: number): void;

Parâmetros

Retornos

A margem do cabeçalho da planilha, em pontos, para uso durante a impressão.

setHeaderMargin(headerMargin: number): void;

Parâmetros

Retornos

A margem esquerda da planilha, em pontos, para uso durante a impressão.

setLeftMargin(leftMargin: number): void;

Parâmetros

Retornos

A orientação da planilha da página.

setOrientation(orientation: PageOrientation): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
  });
}

O tamanho do papel da planilha da página.

setPaperSize(paperSize: PaperType): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
  });
}

Define a área de impressão da planilha.

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

Parâmetros

Retornos

Especifica se os comentários da planilha devem ser exibidos durante a impressão.

setPrintComments(printComments: PrintComments): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
  });
}

A opção de erros de impressão da planilha.

setPrintErrors(printErrors: PrintErrorType): void;

Parâmetros

Retornos

Especifica se as linhas de grade da planilha serão impressas.

setPrintGridlines(printGridlines: boolean): void;

Parâmetros

Retornos

Especifica se os títulos da planilha serão impressos.

setPrintHeadings(printHeadings: boolean): void;

Parâmetros

Retornos

Define as margens das páginas da planilha com unidades.

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

Parâmetros

Retornos

A opção de ordem de impressão de página da planilha. Isso especifica a ordem que será usada para processar o número de página impresso.

setPrintOrder(printOrder: PrintOrder): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
  });
}

Define as colunas que contêm as células que serão repetidas à esquerda de cada página da planilha para impressão.

setPrintTitleColumns(printTitleColumns: Range | string): void;

Parâmetros

Retornos

Define as linhas que contêm as células que serão repetidas na parte de cada página da planilha para impressão.

setPrintTitleRows(printTitleRows: Range | string): void;

Parâmetros

Retornos

A margem direita da planilha, em pontos, para uso durante a impressão.

setRightMargin(rightMargin: number): void;

Parâmetros

Retornos

A margem superior da planilha, em pontos, para uso durante a impressão.

setTopMargin(topMargin: number): void;

Parâmetros

Retornos

As opções de zoom de impressão da planilha. O PageLayoutZoomOptions objeto deve ser definido como um objeto JSON (use x.zoom = {...} em vez de x.zoom.scale = ...).

setZoom(zoom: PageLayoutZoomOptions): void;

Parâmetros

Retornos

Exemplos

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