Excel.PageLayout class
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.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.9]
Propriedades
| black |
A opção de impressão em preto e branco da planilha. |
| bottom |
A margem da página inferior da planilha a ser usada para imprimir em pontos. |
| center |
O sinalizador horizontal central da planilha. Esse sinalizador determina se a planilha será centralizada horizontalmente quando for impressa. |
| center |
O sinalizador vertical centralizado da planilha. Esse sinalizador determina se a planilha será centralizada verticalmente quando for impressa. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| draft |
A opção de modo de rascunho da planilha. Se |
| first |
O primeiro número de página da planilha a ser impressa. Um |
| footer |
A margem do rodapé da planilha, em pontos, para uso na impressão. |
| header |
A margem do cabeçalho da planilha, em pontos, para uso durante a impressão. |
| headers |
Configuração de cabeçalho e rodapé da planilha. |
| left |
A margem esquerda da planilha, em pontos, para uso durante a impressão. |
| orientation | A orientação da planilha da página. |
| paper |
O tamanho do papel da planilha da página. |
| print |
Especifica se os comentários da planilha devem ser exibidos durante a impressão. |
| print |
A opção de erros de impressão da planilha. |
| print |
Especifica se as linhas de grade da planilha serão impressas. |
| print |
Especifica se os títulos da planilha serão impressos. |
| print |
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. |
| right |
A margem direita da planilha, em pontos, para uso durante a impressão. |
| top |
A margem superior da planilha, em pontos, para uso durante a impressão. |
| zoom | As opções de zoom de impressão da planilha. O |
Métodos
| get |
Obtém o |
| get |
Obtém o |
| get |
Obtém o objeto range que representa as colunas de título. |
| get |
Obtém o objeto range que representa as colunas de título. Se não for definido, esse método retornará um objeto com sua |
| get |
Obtém o objeto range representando as linhas do título. |
| get |
Obtém o objeto range representando as linhas do título. Se não for definido, esse método retornará um objeto com sua |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| set |
Define a área de impressão da planilha. |
| set |
Define as margens das páginas da planilha com unidades. |
| set |
Define as margens das páginas da planilha com unidades. |
| set |
Define as colunas que contêm as células que serão repetidas à esquerda de cada página da planilha para impressão. |
| set |
Define as linhas que contêm as células que serão repetidas na parte de cada página da planilha para impressão. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
blackAndWhite
A opção de impressão em preto e branco da planilha.
blackAndWhite: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.9]
bottomMargin
A margem da página inferior da planilha a ser usada para imprimir em pontos.
bottomMargin: number;Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.9]
centerHorizontally
O sinalizador horizontal central da planilha. Esse sinalizador determina se a planilha será centralizada horizontalmente quando for impressa.
centerHorizontally: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.9]
centerVertically
O sinalizador vertical centralizado da planilha. Esse sinalizador determina se a planilha será centralizada verticalmente quando for impressa.
centerVertically: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.9]
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
draftMode
A opção de modo de rascunho da planilha. Se true, a folha será impressa sem gráficos.
draftMode: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.9]
firstPageNumber
O primeiro número de página da planilha a ser impressa. Um null valor representa a numeração de página "automática".
firstPageNumber: number | "";Valor da propriedade
number | ""
Comentários
[Conjunto de apis: ExcelApi 1.9]
footerMargin
A margem do rodapé da planilha, em pontos, para uso na impressão.
footerMargin: number;Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.9]
headerMargin
A margem do cabeçalho da planilha, em pontos, para uso durante a impressão.
headerMargin: number;Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.9]
headersFooters
Configuração de cabeçalho e rodapé da planilha.
readonly headersFooters: Excel.HeaderFooterGroup;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.9]
leftMargin
A margem esquerda da planilha, em pontos, para uso durante a impressão.
leftMargin: number;Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.9]
orientation
A orientação da planilha da página.
orientation: Excel.PageOrientation | "Portrait" | "Landscape";Valor da propriedade
Excel.PageOrientation | "Portrait" | "Landscape"
Comentários
[Conjunto de apis: ExcelApi 1.9]
paperSize
O tamanho do papel da planilha da página.
paperSize: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman";Valor da propriedade
Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman"
Comentários
[Conjunto de apis: ExcelApi 1.9]
printComments
Especifica se os comentários da planilha devem ser exibidos durante a impressão.
printComments: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";Valor da propriedade
Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"
Comentários
[Conjunto de apis: ExcelApi 1.9]
printErrors
A opção de erros de impressão da planilha.
printErrors: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable";Valor da propriedade
Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"
Comentários
[Conjunto de apis: ExcelApi 1.9]
printGridlines
Especifica se as linhas de grade da planilha serão impressas.
printGridlines: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.9]
printHeadings
Especifica se os títulos da planilha serão impressos.
printHeadings: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.9]
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.
printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";Valor da propriedade
Excel.PrintOrder | "DownThenOver" | "OverThenDown"
Comentários
[Conjunto de apis: ExcelApi 1.9]
rightMargin
A margem direita da planilha, em pontos, para uso durante a impressão.
rightMargin: number;Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.9]
topMargin
A margem superior da planilha, em pontos, para uso durante a impressão.
topMargin: number;Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.9]
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 = ...).
zoom: Excel.PageLayoutZoomOptions;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.9]
Detalhes do método
getPrintArea()
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, um ItemNotFound erro será gerado.
getPrintArea(): Excel.RangeAreas;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.9]
getPrintAreaOrNullObject()
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á um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getPrintAreaOrNullObject(): Excel.RangeAreas;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.9]
getPrintTitleColumns()
Obtém o objeto range que representa as colunas de título.
getPrintTitleColumns(): Excel.Range;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.9]
getPrintTitleColumnsOrNullObject()
Obtém o objeto range que representa as colunas de título. Se não for definido, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getPrintTitleColumnsOrNullObject(): Excel.Range;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.9]
getPrintTitleRows()
Obtém o objeto range representando as linhas do título.
getPrintTitleRows(): Excel.Range;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.9]
getPrintTitleRowsOrNullObject()
Obtém o objeto range representando as linhas do título. Se não for definido, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getPrintTitleRowsOrNullObject(): Excel.Range;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.9]
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout;Parâmetros
Fornece opções para quais propriedades do objeto devem ser carregadas.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.PageLayout;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.PageLayout;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.PageLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.PageLayoutUpdateData
Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
set(properties: Excel.PageLayout): void;Parâmetros
- properties
- Excel.PageLayout
Retornos
void
setPrintArea(printArea)
Define a área de impressão da planilha.
setPrintArea(printArea: Range | RangeAreas | string): void;Parâmetros
- printArea
-
Excel.Range | Excel.RangeAreas | string
O intervalo ou intervalos do conteúdo a ser impresso.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.9]
setPrintMargins(unit, marginOptions)
Define as margens das páginas da planilha com unidades.
setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions): void;Parâmetros
Unidade de medida para as margens fornecidas.
- marginOptions
- Excel.PageLayoutMarginOptions
Valores de margem a serem definidos. As margens não fornecidas permanecem inalteradas.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.9]
setPrintMargins(unit, marginOptions)
Define as margens das páginas da planilha com unidades.
setPrintMargins(unit: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void;Parâmetros
- unit
-
"Points" | "Inches" | "Centimeters"
Unidade de medida para as margens fornecidas.
- marginOptions
- Excel.PageLayoutMarginOptions
Valores de margem a serem definidos. As margens não fornecidas permanecem inalteradas.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.9]
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
-
Excel.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
Comentários
[Conjunto de apis: ExcelApi 1.9]
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
-
Excel.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
Comentários
[Conjunto de apis: ExcelApi 1.9]
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.PageLayout é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.PageLayoutData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.PageLayoutData;