ExcelScript.PageLayout interface

Representa as 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.

Métodos

getBlackAndWhite()

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

getBottomMargin()

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

getCenterHorizontally()

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

getCenterVertically()

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

getDraftMode()

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

getFirstPageNumber()

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

getFooterMargin()

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

getHeaderMargin()

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

getHeadersFooters()

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

getLeftMargin()

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

getOrientation()

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

getPaperSize()

O tamanho de papel da página da planilha.

getPrintArea()

Obtém o objeto RangeAreas, compreendendo um ou mais intervalos retangulares, que representa a área de impressão da planilha. Se não houver uma área de impressão, um objeto null será retornado.

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

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.

getPrintTitleColumns()

Obtém o objeto range que representa as colunas de título. Se não estiver configurado, retornará um objeto null.

getPrintTitleRows()

Obtém o objeto range representando as linhas do título. Se não estiver configurado, retornará um objeto null.

getRightMargin()

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

getTopMargin()

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

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 dex.zoom.scale = ...).

setBlackAndWhite(blackAndWhite)

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

setBottomMargin(bottomMargin)

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

setCenterHorizontally(centerHorizontally)

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

setCenterVertically(centerVertically)

O sinalizador da planilha centralizado 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 for true, a planilha será impressa sem gráficos.

setFirstPageNumber(firstPageNumber)

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

setFooterMargin(footerMargin)

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

setHeaderMargin(headerMargin)

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

setLeftMargin(leftMargin)

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

setOrientation(orientation)

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

setPaperSize(paperSize)

O tamanho de papel da página da planilha.

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)

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.

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 na impressão.

setTopMargin(topMargin)

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

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 dex.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 inferior da página da planilha a ser usada para impressão em pontos.

getBottomMargin(): number;

Retornos

number

getCenterHorizontally()

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

getCenterHorizontally(): boolean;

Retornos

boolean

getCenterVertically()

O sinalizador da planilha centralizado 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 for true, a planilha será impressa sem gráficos.

getDraftMode(): boolean;

Retornos

boolean

getFirstPageNumber()

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

getFirstPageNumber(): number | "";

Retornos

number | ""

getFooterMargin()

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

getFooterMargin(): number;

Retornos

number

getHeaderMargin()

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

getHeaderMargin(): number;

Retornos

number

getHeadersFooters()

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

getHeadersFooters(): HeaderFooterGroup;

Retornos

getLeftMargin()

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

getLeftMargin(): number;

Retornos

number

getOrientation()

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

getOrientation(): PageOrientation;

Retornos

getPaperSize()

O tamanho de papel da página da planilha.

getPaperSize(): PaperType;

Retornos

getPrintArea()

Obtém o objeto RangeAreas, compreendendo um ou mais intervalos retangulares, que representa a área de impressão da planilha. Se não houver uma área de impressão, um objeto null será retornado.

getPrintArea(): RangeAreas;

Retornos

getPrintComments()

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

getPrintComments(): PrintComments;

Retornos

getPrintErrors()

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

getPrintErrors(): PrintErrorType;

Retornos

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

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

getPrintTitleColumns()

Obtém o objeto range que representa as colunas de título. Se não estiver configurado, retornará um objeto null.

getPrintTitleColumns(): Range;

Retornos

getPrintTitleRows()

Obtém o objeto range representando as linhas do título. Se não estiver configurado, retornará um objeto null.

getPrintTitleRows(): Range;

Retornos

getRightMargin()

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

getRightMargin(): number;

Retornos

number

getTopMargin()

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

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 dex.zoom.scale = ...).

getZoom(): PageLayoutZoomOptions;

Retornos

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 inferior da página da planilha a ser usada para impressão em pontos.

setBottomMargin(bottomMargin: number): void;

Parâmetros

bottomMargin
number

Retornos

void

setCenterHorizontally(centerHorizontally)

O sinalizador da planilha centralizado 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 da planilha centralizado 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 for true, a planilha será impressa sem gráficos.

setDraftMode(draftMode: boolean): void;

Parâmetros

draftMode
boolean

Retornos

void

setFirstPageNumber(firstPageNumber)

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

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

Parâmetros

firstPageNumber
number | ""

Retornos

void

setFooterMargin(footerMargin)

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

setFooterMargin(footerMargin: number): void;

Parâmetros

footerMargin
number

Retornos

void

setHeaderMargin(headerMargin)

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

setHeaderMargin(headerMargin: number): void;

Parâmetros

headerMargin
number

Retornos

void

setLeftMargin(leftMargin)

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

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
PageOrientation

Retornos

void

setPaperSize(paperSize)

O tamanho de papel da página da planilha.

setPaperSize(paperSize: PaperType): void;

Parâmetros

paperSize
PaperType

Retornos

void

setPrintArea(printArea)

Define a área de impressão da planilha.

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

Parâmetros

printArea
Range | RangeAreas | string

O intervalo ou RangeAreas 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
PrintComments

Retornos

void

setPrintErrors(printErrors)

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

setPrintErrors(printErrors: PrintErrorType): void;

Parâmetros

printErrors
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
PrintMarginUnit

Unidade de medida das margens fornecidas.

marginOptions
PageLayoutMarginOptions

Os valores de margem a serem definidos, as margens não fornecidas permanecerão inalteradas.

Retornos

void

setPrintOrder(printOrder)

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

printOrder
PrintOrder

Retornos

void

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
Range | string

As colunas a serem repetidas à esquerda de cada página, o intervalo deve ocupar a coluna inteira 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
Range | string

As linhas a serem repetidas na parte superior de cada página, o intervalo deve abranger a linha inteira para ser válida.

Retornos

void

setRightMargin(rightMargin)

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

setRightMargin(rightMargin: number): void;

Parâmetros

rightMargin
number

Retornos

void

setTopMargin(topMargin)

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

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 dex.zoom.scale = ...).

setZoom(zoom: PageLayoutZoomOptions): void;

Parâmetros

Retornos

void