ExcelScript.PageLayout interface

Referência

Pacote:: ExcelScript

Representa configurações de layout e impressão que não dependem de nenhuma implementação específica da impressora. Essas configurações incluem margens, orientação, numeração de página, linhas de título e a área de impressão.

Comentários

Exemplos

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

Métodos

getBlackAndWhite()	A opção de impressão em preto e branco da planilha.
getBottomMargin()	A margem de página inferior da planilha a ser usada para impressão em pontos.
getCenterHorizontally()	O sinalizador central da planilha horizontalmente. Esse sinalizador determina se a planilha será centralizada horizontalmente quando for impressa.
getCenterVertically()	O sinalizador central da planilha verticalmente. Esse sinalizador determina se a planilha será centralizada verticalmente quando for impressa.
getDraftMode()	A opção de modo de rascunho da planilha. Se `true`, a folha será impressa sem gráficos.
getFirstPageNumber()	O primeiro número de página da planilha a ser impresso. Um `null` valor representa a numeração de página "automática".
getFooterMargin()	A margem de rodapé da planilha, em pontos, para uso ao imprimir.
getHeaderMargin()	A margem de cabeçalho da planilha, em pontos, para uso ao imprimir.
getHeadersFooters()	Configuração de cabeçalho e rodapé da planilha.
getLeftMargin()	A margem esquerda da planilha, em pontos, para uso ao imprimir.
getOrientation()	A orientação da planilha da página.
getPaperSize()	O tamanho do papel da planilha da página.
getPrintArea()	Obtém o `RangeAreas` objeto, composto por um ou mais intervalos retangulares, que representa a área de impressão da planilha. Se não houver nenhuma área de impressão, esse método retornará `undefined`.
getPrintComments()	Especifica se os comentários da planilha devem ser exibidos ao imprimir.
getPrintErrors()	A opção de erros de impressão da planilha.
getPrintGridlines()	Especifica se as linhas de grade da planilha serão impressas.
getPrintHeadings()	Especifica se os títulos da planilha serão impressos.
getPrintOrder()	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.
getPrintTitleColumns()	Obtém o objeto range que representa as colunas de título. Se não estiver definido, esse método retornará `undefined`.
getPrintTitleRows()	Obtém o objeto range representando as linhas do título. Se não estiver definido, esse método retornará `undefined`.
getRightMargin()	A margem direita da planilha, em pontos, para uso ao imprimir.
getTopMargin()	A margem superior da planilha, em pontos, para uso ao imprimir.
getZoom()	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 = ...`).
setBlackAndWhite(blackAndWhite)	A opção de impressão em preto e branco da planilha.
setBottomMargin(bottomMargin)	A margem de página inferior da planilha a ser usada para impressão em pontos.
setCenterHorizontally(centerHorizontally)	O sinalizador central da planilha horizontalmente. Esse sinalizador determina se a planilha será centralizada horizontalmente quando for impressa.
setCenterVertically(centerVertically)	O sinalizador central da planilha verticalmente. Esse sinalizador determina se a planilha será centralizada verticalmente quando for impressa.
setDraftMode(draftMode)	A opção de modo de rascunho da planilha. Se `true`, a folha será impressa sem gráficos.
setFirstPageNumber(firstPageNumber)	O primeiro número de página da planilha a ser impresso. Um `null` valor representa a numeração de página "automática".
setFooterMargin(footerMargin)	A margem de rodapé da planilha, em pontos, para uso ao imprimir.
setHeaderMargin(headerMargin)	A margem de cabeçalho da planilha, em pontos, para uso ao imprimir.
setLeftMargin(leftMargin)	A margem esquerda da planilha, em pontos, para uso ao imprimir.
setOrientation(orientation)	A orientação da planilha da página.
setPaperSize(paperSize)	O tamanho do papel da planilha da página.
setPrintArea(printArea)	Define a área de impressão da planilha.
setPrintComments(printComments)	Especifica se os comentários da planilha devem ser exibidos ao imprimir.
setPrintErrors(printErrors)	A opção de erros de impressão da planilha.
setPrintGridlines(printGridlines)	Especifica se as linhas de grade da planilha serão impressas.
setPrintHeadings(printHeadings)	Especifica se os títulos da planilha serão impressos.
setPrintMargins(unit, marginOptions)	Define as margens das páginas da planilha com unidades.
setPrintOrder(printOrder)	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.
setPrintTitleColumns(printTitleColumns)	Define as colunas que contêm as células que serão repetidas à esquerda de cada página da planilha para impressão.
setPrintTitleRows(printTitleRows)	Define as linhas que contêm as células que serão repetidas na parte de cada página da planilha para impressão.
setRightMargin(rightMargin)	A margem direita da planilha, em pontos, para uso ao imprimir.
setTopMargin(topMargin)	A margem superior da planilha, em pontos, para uso ao imprimir.
setZoom(zoom)	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 = ...`).

Detalhes do método

getBlackAndWhite()

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

getBlackAndWhite(): boolean;

Retornos

boolean

getBottomMargin()

A margem de página inferior da planilha a ser usada para impressão em pontos.

getBottomMargin(): number;

Retornos

number

getCenterHorizontally()

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

getCenterHorizontally(): boolean;

Retornos

boolean

getCenterVertically()

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

getCenterVertically(): boolean;

Retornos

boolean

getDraftMode()

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

getDraftMode(): boolean;

Retornos

boolean

getFirstPageNumber()

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

getFirstPageNumber(): number | "";

Retornos

number | ""

getFooterMargin()

A margem de rodapé da planilha, em pontos, para uso ao imprimir.

getFooterMargin(): number;

Retornos

number

getHeaderMargin()

A margem de cabeçalho da planilha, em pontos, para uso ao imprimir.

getHeaderMargin(): number;

Retornos

number

getHeadersFooters()

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

getHeadersFooters(): HeaderFooterGroup;

Retornos

ExcelScript.HeaderFooterGroup

getLeftMargin()

A margem esquerda da planilha, em pontos, para uso ao imprimir.

getLeftMargin(): number;

Retornos

number

getOrientation()

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

getOrientation(): PageOrientation;

Retornos

ExcelScript.PageOrientation

getPaperSize()

O tamanho do papel da planilha da página.

getPaperSize(): PaperType;

Retornos

ExcelScript.PaperType

getPrintArea()

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

getPrintArea(): RangeAreas;

Retornos

ExcelScript.RangeAreas

getPrintComments()

Especifica se os comentários da planilha devem ser exibidos ao imprimir.

getPrintComments(): PrintComments;

Retornos

ExcelScript.PrintComments

getPrintErrors()

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

getPrintErrors(): PrintErrorType;

Retornos

ExcelScript.PrintErrorType

getPrintGridlines()

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

getPrintGridlines(): boolean;

Retornos

boolean

getPrintHeadings()

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

getPrintHeadings(): boolean;

Retornos

boolean

getPrintOrder()

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

ExcelScript.PrintOrder

getPrintTitleColumns()

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

getPrintTitleColumns(): Range;

Retornos

ExcelScript.Range

getPrintTitleRows()

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

getPrintTitleRows(): Range;

Retornos

ExcelScript.Range

getRightMargin()

A margem direita da planilha, em pontos, para uso ao imprimir.

getRightMargin(): number;

Retornos

number

getTopMargin()

A margem superior da planilha, em pontos, para uso ao imprimir.

getTopMargin(): number;

Retornos

number

getZoom()

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

ExcelScript.PageLayoutZoomOptions

setBlackAndWhite(blackAndWhite)

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

setBlackAndWhite(blackAndWhite: boolean): void;

Parâmetros

blackAndWhite: boolean

Retornos

void

setBottomMargin(bottomMargin)

A margem de página inferior da planilha a ser usada para impressão em pontos.

setBottomMargin(bottomMargin: number): void;

Parâmetros

bottomMargin: number

Retornos

void

setCenterHorizontally(centerHorizontally)

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

setCenterHorizontally(centerHorizontally: boolean): void;

Parâmetros

centerHorizontally: boolean

Retornos

void

setCenterVertically(centerVertically)

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

setCenterVertically(centerVertically: boolean): void;

Parâmetros

centerVertically: boolean

Retornos

void

setDraftMode(draftMode)

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

setDraftMode(draftMode: boolean): void;

Parâmetros

draftMode: boolean

Retornos

void

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

setFirstPageNumber(firstPageNumber)

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

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

Parâmetros

firstPageNumber: number | ""

Retornos

void

setFooterMargin(footerMargin)

A margem de rodapé da planilha, em pontos, para uso ao imprimir.

setFooterMargin(footerMargin: number): void;

Parâmetros

footerMargin: number

Retornos

void

setHeaderMargin(headerMargin)

A margem de cabeçalho da planilha, em pontos, para uso ao imprimir.

setHeaderMargin(headerMargin: number): void;

Parâmetros

headerMargin: number

Retornos

void

setLeftMargin(leftMargin)

A margem esquerda da planilha, em pontos, para uso ao imprimir.

setLeftMargin(leftMargin: number): void;

Parâmetros

leftMargin: number

Retornos

void

setOrientation(orientation)

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

setOrientation(orientation: PageOrientation): void;

Parâmetros

orientation: ExcelScript.PageOrientation

Retornos

void

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

setPaperSize(paperSize)

O tamanho do papel da planilha da página.

setPaperSize(paperSize: PaperType): void;

Parâmetros

paperSize: ExcelScript.PaperType

Retornos

void

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

setPrintArea(printArea)

Define a área de impressão da planilha.

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

Parâmetros

printArea: ExcelScript.Range | ExcelScript.RangeAreas | string

O intervalo ou intervalos do conteúdo a ser impresso.

Retornos

void

setPrintComments(printComments)

Especifica se os comentários da planilha devem ser exibidos ao imprimir.

setPrintComments(printComments: PrintComments): void;

Parâmetros

printComments: ExcelScript.PrintComments

Retornos

void

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

setPrintErrors(printErrors)

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

setPrintErrors(printErrors: PrintErrorType): void;

Parâmetros

printErrors: ExcelScript.PrintErrorType

Retornos

void

setPrintGridlines(printGridlines)

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

setPrintGridlines(printGridlines: boolean): void;

Parâmetros

printGridlines: boolean

Retornos

void

setPrintHeadings(printHeadings)

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

setPrintHeadings(printHeadings: boolean): void;

Parâmetros

printHeadings: boolean

Retornos

void

setPrintMargins(unit, marginOptions)

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

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

Parâmetros

unit: ExcelScript.PrintMarginUnit

Unidade de medição para as margens fornecidas.

marginOptions: ExcelScript.PageLayoutMarginOptions

Valores de margem a serem definidos. As margens não fornecidas permanecem inalteradas.

Retornos

void

setPrintOrder(printOrder)

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

printOrder: ExcelScript.PrintOrder

Retornos

void

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

setPrintTitleColumns(printTitleColumns)

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

printTitleColumns: ExcelScript.Range | string

As colunas a serem repetidas à esquerda de cada página. O intervalo deve abranger toda a coluna para ser válido.

Retornos

void

setPrintTitleRows(printTitleRows)

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

printTitleRows: ExcelScript.Range | string

As linhas a serem repetidas na parte superior de cada página. O intervalo deve abranger toda a linha para ser válido.

Retornos

void

setRightMargin(rightMargin)

A margem direita da planilha, em pontos, para uso ao imprimir.

setRightMargin(rightMargin: number): void;

Parâmetros

rightMargin: number

Retornos

void

setTopMargin(topMargin)

A margem superior da planilha, em pontos, para uso ao imprimir.

setTopMargin(topMargin: number): void;

Parâmetros

topMargin: number

Retornos

void

setZoom(zoom)

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

zoom: ExcelScript.PageLayoutZoomOptions

Retornos

void