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 API: ExcelApi 1.9 ]
Propriedades
| black |
A opção de impressão em preto e branco da planilha. |
| bottom |
A margem de página inferior da planilha a ser usada para impressão em pontos. |
| center |
O sinalizador central da planilha horizontalmente. Esse sinalizador determina se a planilha será centralizada horizontalmente quando for impressa. |
| center |
O sinalizador central da planilha verticalmente. 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 impresso. Um |
| footer |
A margem de rodapé da planilha, em pontos, para uso ao imprimir. |
| header |
A margem de cabeçalho da planilha, em pontos, para uso ao imprimir. |
| headers |
Configuração de cabeçalho e rodapé da planilha. |
| left |
A margem esquerda da planilha, em pontos, para uso ao imprimir. |
| 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 ao imprimir. |
| 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 |
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 ao imprimir. |
| top |
A margem superior da planilha, em pontos, para uso ao imprimir. |
| 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 estiver 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 estiver 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
bottomMargin
A margem de página inferior da planilha a ser usada para impressão em pontos.
bottomMargin: number;Valor da propriedade
number
Comentários
centerHorizontally
O sinalizador central da planilha horizontalmente. Esse sinalizador determina se a planilha será centralizada horizontalmente quando for impressa.
centerHorizontally: boolean;Valor da propriedade
boolean
Comentários
[ Conjunto de API: ExcelApi 1.9 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.centerHorizontally = true;
farmSheet.pageLayout.centerVertically = true;
await context.sync();
});
centerVertically
O sinalizador central da planilha verticalmente. Esse sinalizador determina se a planilha será centralizada verticalmente quando for impressa.
centerVertically: boolean;Valor da propriedade
boolean
Comentários
[ Conjunto de API: ExcelApi 1.9 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.centerHorizontally = true;
farmSheet.pageLayout.centerVertically = true;
await context.sync();
});
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
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".
firstPageNumber: number | "";Valor da propriedade
number | ""
Comentários
footerMargin
A margem de rodapé da planilha, em pontos, para uso ao imprimir.
footerMargin: number;Valor da propriedade
number
Comentários
headerMargin
A margem de cabeçalho da planilha, em pontos, para uso ao imprimir.
headerMargin: number;Valor da propriedade
number
Comentários
headersFooters
Configuração de cabeçalho e rodapé da planilha.
readonly headersFooters: Excel.HeaderFooterGroup;Valor da propriedade
Comentários
leftMargin
A margem esquerda da planilha, em pontos, para uso ao imprimir.
leftMargin: number;Valor da propriedade
number
Comentários
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 API: ExcelApi 1.9 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.orientation = Excel.PageOrientation.landscape;
await context.sync();
});
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
printComments
Especifica se os comentários da planilha devem ser exibidos ao imprimir.
printComments: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";Valor da propriedade
Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"
Comentários
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
printGridlines
Especifica se as linhas de grade da planilha serão impressas.
printGridlines: boolean;Valor da propriedade
boolean
Comentários
printHeadings
Especifica se os títulos da planilha serão impressos.
printHeadings: boolean;Valor da propriedade
boolean
Comentários
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.
printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";Valor da propriedade
Excel.PrintOrder | "DownThenOver" | "OverThenDown"
Comentários
rightMargin
A margem direita da planilha, em pontos, para uso ao imprimir.
rightMargin: number;Valor da propriedade
number
Comentários
topMargin
A margem superior da planilha, em pontos, para uso ao imprimir.
topMargin: number;Valor da propriedade
number
Comentários
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 API: ExcelApi 1.9 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.zoom = { scale: 200 };
await context.sync();
});
Detalhes do método
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 uma área de impressão, um ItemNotFound erro será gerado.
getPrintArea(): Excel.RangeAreas;Retornos
Comentários
getPrintAreaOrNullObject()
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á 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
getPrintTitleColumns()
Obtém o objeto range que representa as colunas de título.
getPrintTitleColumns(): Excel.Range;Retornos
Comentários
getPrintTitleColumnsOrNullObject()
Obtém o objeto range que representa as colunas de título. Se não estiver 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
getPrintTitleRows()
Obtém o objeto range representando as linhas do título.
getPrintTitleRows(): Excel.Range;Retornos
Comentários
getPrintTitleRowsOrNullObject()
Obtém o objeto range representando as linhas do título. Se não estiver 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
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 carregar.
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írgulas ou uma matriz de cadeias de caracteres que especificam 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írgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas 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 properties tentar definir quaisquer 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 API: ExcelApi 1.9 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.setPrintArea("A1:D41");
await context.sync();
});
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 medição para as margens fornecidas.
- marginOptions
- Excel.PageLayoutMarginOptions
Valores de margem a serem definidos. As margens não fornecidas permanecem inalteradas.
Retornos
void
Comentários
setPrintMargins(unitString, marginOptions)
Define as margens das páginas da planilha com unidades.
setPrintMargins(unitString: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void;Parâmetros
- unitString
-
"Points" | "Inches" | "Centimeters"
Unidade de medição para as margens fornecidas.
- marginOptions
- Excel.PageLayoutMarginOptions
Valores de margem a serem definidos. As margens não fornecidas permanecem inalteradas.
Retornos
void
Comentários
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
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 API: ExcelApi 1.9 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.setPrintTitleRows("$1:$1");
await context.sync();
});
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.PageLayout original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.PageLayoutData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.PageLayoutData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de