Compartir a través de

Excel.PageLayout class

  • Referencia
Paquete:
excel

Representa la configuración de diseño e impresión que no depende de ninguna implementación específica de la impresora. Estas opciones incluyen los márgenes, orientación, numeración, filas de título y el área de impresión.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Propiedades

blackAndWhite

Opción de impresión en blanco y negro de la hoja de cálculo.
bottomMargin

Margen de página inferior de la hoja de cálculo que se va a usar para imprimir en puntos.
centerHorizontally

Marca del centro de la hoja de cálculo horizontalmente. Esta marca determina si se centrará horizontalmente la hoja de cálculo cuando se imprime.
centerVertically

Marca del centro de la hoja de cálculo verticalmente. Esta marca determina si se centrará verticalmente la hoja de cálculo cuando se imprime.
context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
draftMode

Opción de modo de borrador de la hoja de cálculo. Si truees , la hoja se imprimirá sin gráficos.
firstPageNumber

Primer número de página de la hoja de cálculo que se va a imprimir. Un null valor representa la numeración de páginas "auto".
footerMargin

Margen de pie de página de la hoja de cálculo, en puntos, para su uso al imprimir.
headerMargin

Margen de encabezado de la hoja de cálculo, en puntos, para su uso al imprimir.
headersFooters

Configuración de encabezado y pie de página de la hoja de cálculo.
leftMargin

Margen izquierdo de la hoja de cálculo, en puntos, para su uso al imprimir.
orientation

Orientación de la hoja de cálculo de la página.
paperSize

Tamaño de papel de la hoja de cálculo de la página.
printComments

Especifica si se deben mostrar los comentarios de la hoja de cálculo al imprimir.
printErrors

Opción de errores de impresión de la hoja de cálculo.
printGridlines

Especifica si se imprimirán las líneas de cuadrícula de la hoja de cálculo.
printHeadings

Especifica si se imprimirán los encabezados de la hoja de cálculo.
printOrder

Opción de orden de impresión de página de la hoja de cálculo. Especifica el orden para procesar el número de página que se imprime.
rightMargin

Margen derecho de la hoja de cálculo, en puntos, para su uso al imprimir.
topMargin

Margen superior de la hoja de cálculo, en puntos, para su uso al imprimir.
zoom

Opciones de zoom de impresión de la hoja de cálculo. El PageLayoutZoomOptions objeto debe establecerse como un objeto JSON (use x.zoom = {...} en lugar de x.zoom.scale = ...).

Métodos

getPrintArea()

Obtiene el RangeAreas objeto, que consta de uno o varios rangos rectangulares, que representa el área de impresión de la hoja de cálculo. Si no hay ningún área de impresión, se producirá un ItemNotFound error.
getPrintAreaOrNullObject()

Obtiene el RangeAreas objeto, que consta de uno o varios rangos rectangulares, que representa el área de impresión de la hoja de cálculo. Si no hay ningún área de impresión, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getPrintTitleColumns()

Obtiene el objeto de intervalo que representa las columnas de título.
getPrintTitleColumnsOrNullObject()

Obtiene el objeto de intervalo que representa las columnas de título. Si no se establece, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getPrintTitleRows()

Obtiene el objeto de intervalo que representa las filas de título.
getPrintTitleRowsOrNullObject()

Obtiene el objeto de intervalo que representa las filas de título. Si no se establece, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
setPrintArea(printArea)

Establece el área de impresión de la hoja de cálculo.
setPrintMargins(unit, marginOptions)

Establece los márgenes de página de la hoja de cálculo con unidades.
setPrintMargins(unitString, marginOptions)

Establece los márgenes de página de la hoja de cálculo con unidades.
setPrintTitleColumns(printTitleColumns)

Establece las columnas que contienen las celdas que se repetirán a la izquierda de cada página de la hoja de cálculo que se va a imprimir.
setPrintTitleRows(printTitleRows)

Establece las filas que contienen las celdas que se repetirán en la parte superior de cada página de la hoja de cálculo que se va a imprimir.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.PageLayout es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.PageLayoutData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

blackAndWhite

Opción de impresión en blanco y negro de la hoja de cálculo.

blackAndWhite: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

bottomMargin

Margen de página inferior de la hoja de cálculo que se va a usar para imprimir en puntos.

bottomMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

centerHorizontally

Marca del centro de la hoja de cálculo horizontalmente. Esta marca determina si se centrará horizontalmente la hoja de cálculo cuando se imprime.

centerHorizontally: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

// 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

Marca del centro de la hoja de cálculo verticalmente. Esta marca determina si se centrará verticalmente la hoja de cálculo cuando se imprime.

centerVertically: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

// 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

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

draftMode

Opción de modo de borrador de la hoja de cálculo. Si truees , la hoja se imprimirá sin gráficos.

draftMode: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

firstPageNumber

Primer número de página de la hoja de cálculo que se va a imprimir. Un null valor representa la numeración de páginas "auto".

firstPageNumber: number | "";

Valor de propiedad

number | ""

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

footerMargin

Margen de pie de página de la hoja de cálculo, en puntos, para su uso al imprimir.

footerMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

headerMargin

Margen de encabezado de la hoja de cálculo, en puntos, para su uso al imprimir.

headerMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

headersFooters

Configuración de encabezado y pie de página de la hoja de cálculo.

readonly headersFooters: Excel.HeaderFooterGroup;

Valor de propiedad

Excel.HeaderFooterGroup

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

leftMargin

Margen izquierdo de la hoja de cálculo, en puntos, para su uso al imprimir.

leftMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

orientation

Orientación de la hoja de cálculo de la página.

orientation: Excel.PageOrientation | "Portrait" | "Landscape";

Valor de propiedad

Excel.PageOrientation | "Portrait" | "Landscape"

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

// 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

Tamaño de papel de la hoja de cálculo de la 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 de propiedad

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"

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

printComments

Especifica si se deben mostrar los comentarios de la hoja de cálculo al imprimir.

printComments: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";

Valor de propiedad

Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

printErrors

Opción de errores de impresión de la hoja de cálculo.

printErrors: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable";

Valor de propiedad

Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

printGridlines

Especifica si se imprimirán las líneas de cuadrícula de la hoja de cálculo.

printGridlines: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

printHeadings

Especifica si se imprimirán los encabezados de la hoja de cálculo.

printHeadings: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

printOrder

Opción de orden de impresión de página de la hoja de cálculo. Especifica el orden para procesar el número de página que se imprime.

printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";

Valor de propiedad

Excel.PrintOrder | "DownThenOver" | "OverThenDown"

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

rightMargin

Margen derecho de la hoja de cálculo, en puntos, para su uso al imprimir.

rightMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

topMargin

Margen superior de la hoja de cálculo, en puntos, para su uso al imprimir.

topMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

zoom

Opciones de zoom de impresión de la hoja de cálculo. El PageLayoutZoomOptions objeto debe establecerse como un objeto JSON (use x.zoom = {...} en lugar de x.zoom.scale = ...).

zoom: Excel.PageLayoutZoomOptions;

Valor de propiedad

Excel.PageLayoutZoomOptions

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

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

Detalles del método

getPrintArea()

Obtiene el RangeAreas objeto, que consta de uno o varios rangos rectangulares, que representa el área de impresión de la hoja de cálculo. Si no hay ningún área de impresión, se producirá un ItemNotFound error.

getPrintArea(): Excel.RangeAreas;

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getPrintAreaOrNullObject()

Obtiene el RangeAreas objeto, que consta de uno o varios rangos rectangulares, que representa el área de impresión de la hoja de cálculo. Si no hay ningún área de impresión, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getPrintAreaOrNullObject(): Excel.RangeAreas;

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getPrintTitleColumns()

Obtiene el objeto de intervalo que representa las columnas de título.

getPrintTitleColumns(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getPrintTitleColumnsOrNullObject()

Obtiene el objeto de intervalo que representa las columnas de título. Si no se establece, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getPrintTitleColumnsOrNullObject(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getPrintTitleRows()

Obtiene el objeto de intervalo que representa las filas de título.

getPrintTitleRows(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getPrintTitleRowsOrNullObject()

Obtiene el objeto de intervalo que representa las filas de título. Si no se establece, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getPrintTitleRowsOrNullObject(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout;

Parámetros

options
Excel.Interfaces.PageLayoutLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.PageLayout

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.PageLayout;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.PageLayout

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.PageLayout;

Parámetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.PageLayout

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

set(properties: Interfaces.PageLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties
Excel.Interfaces.PageLayoutUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options
OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.PageLayout): void;

Parámetros

properties
Excel.PageLayout

Devoluciones

void

setPrintArea(printArea)

Establece el área de impresión de la hoja de cálculo.

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

Parámetros

printArea

Excel.Range | Excel.RangeAreas | string

Intervalo o intervalos del contenido que se va a imprimir.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

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

Establece los márgenes de página de la hoja de cálculo con unidades.

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

Parámetros

unit
Excel.PrintMarginUnit

Unidad de medida para los márgenes proporcionados.

marginOptions
Excel.PageLayoutMarginOptions

Valores de margen que se van a establecer. Los márgenes no proporcionados permanecen sin cambios.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

setPrintMargins(unitString, marginOptions)

Establece los márgenes de página de la hoja de cálculo con unidades.

setPrintMargins(unitString: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void;

Parámetros

unitString

"Points" | "Inches" | "Centimeters"

Unidad de medida para los márgenes proporcionados.

marginOptions
Excel.PageLayoutMarginOptions

Valores de margen que se van a establecer. Los márgenes no proporcionados permanecen sin cambios.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

setPrintTitleColumns(printTitleColumns)

Establece las columnas que contienen las celdas que se repetirán a la izquierda de cada página de la hoja de cálculo que se va a imprimir.

setPrintTitleColumns(printTitleColumns: Range | string): void;

Parámetros

printTitleColumns

Excel.Range | string

Columnas que se repetirán a la izquierda de cada página. El intervalo debe abarcar toda la columna para que sea válido.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

setPrintTitleRows(printTitleRows)

Establece las filas que contienen las celdas que se repetirán en la parte superior de cada página de la hoja de cálculo que se va a imprimir.

setPrintTitleRows(printTitleRows: Range | string): void;

Parámetros

printTitleRows

Excel.Range | string

Filas que se repetirán en la parte superior de cada página. El intervalo debe abarcar toda la fila para que sea válido.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

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

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.PageLayout es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.PageLayoutData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.PageLayoutData;

Devoluciones

Excel.Interfaces.PageLayoutData