ExcelScript.PageLayout interface

Referencia

Paquete:: ExcelScript

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.

Comentarios

Ejemplos

/**
 * 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()	Opción de impresión en blanco y negro de la hoja de cálculo.
getBottomMargin()	Margen de página inferior de la hoja de cálculo que se va a usar para imprimir en puntos.
getCenterHorizontally()	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.
getCenterVertically()	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.
getDraftMode()	Opción de modo de borrador de la hoja de cálculo. Si `true`es , la hoja se imprimirá sin gráficos.
getFirstPageNumber()	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".
getFooterMargin()	Margen de pie de página de la hoja de cálculo, en puntos, para su uso al imprimir.
getHeaderMargin()	Margen de encabezado de la hoja de cálculo, en puntos, para su uso al imprimir.
getHeadersFooters()	Configuración de encabezado y pie de página de la hoja de cálculo.
getLeftMargin()	Margen izquierdo de la hoja de cálculo, en puntos, para su uso al imprimir.
getOrientation()	Orientación de la hoja de cálculo de la página.
getPaperSize()	Tamaño de papel de la hoja de cálculo de la página.
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, este método devuelve `undefined`.
getPrintComments()	Especifica si se deben mostrar los comentarios de la hoja de cálculo al imprimir.
getPrintErrors()	Opción de errores de impresión de la hoja de cálculo.
getPrintGridlines()	Especifica si se imprimirán las líneas de cuadrícula de la hoja de cálculo.
getPrintHeadings()	Especifica si se imprimirán los encabezados de la hoja de cálculo.
getPrintOrder()	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.
getPrintTitleColumns()	Obtiene el objeto de intervalo que representa las columnas de título. Si no se establece, este método devuelve `undefined`.
getPrintTitleRows()	Obtiene el objeto de intervalo que representa las filas de título. Si no se establece, este método devuelve `undefined`.
getRightMargin()	Margen derecho de la hoja de cálculo, en puntos, para su uso al imprimir.
getTopMargin()	Margen superior de la hoja de cálculo, en puntos, para su uso al imprimir.
getZoom()	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 = ...`).
setBlackAndWhite(blackAndWhite)	Opción de impresión en blanco y negro de la hoja de cálculo.
setBottomMargin(bottomMargin)	Margen de página inferior de la hoja de cálculo que se va a usar para imprimir en puntos.
setCenterHorizontally(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.
setCenterVertically(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.
setDraftMode(draftMode)	Opción de modo de borrador de la hoja de cálculo. Si `true`es , la hoja se imprimirá sin gráficos.
setFirstPageNumber(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".
setFooterMargin(footerMargin)	Margen de pie de página de la hoja de cálculo, en puntos, para su uso al imprimir.
setHeaderMargin(headerMargin)	Margen de encabezado de la hoja de cálculo, en puntos, para su uso al imprimir.
setLeftMargin(leftMargin)	Margen izquierdo de la hoja de cálculo, en puntos, para su uso al imprimir.
setOrientation(orientation)	Orientación de la hoja de cálculo de la página.
setPaperSize(paperSize)	Tamaño de papel de la hoja de cálculo de la página.
setPrintArea(printArea)	Establece el área de impresión de la hoja de cálculo.
setPrintComments(printComments)	Especifica si se deben mostrar los comentarios de la hoja de cálculo al imprimir.
setPrintErrors(printErrors)	Opción de errores de impresión de la hoja de cálculo.
setPrintGridlines(printGridlines)	Especifica si se imprimirán las líneas de cuadrícula de la hoja de cálculo.
setPrintHeadings(printHeadings)	Especifica si se imprimirán los encabezados de la hoja de cálculo.
setPrintMargins(unit, marginOptions)	Establece los márgenes de página de la hoja de cálculo con unidades.
setPrintOrder(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.
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.
setRightMargin(rightMargin)	Margen derecho de la hoja de cálculo, en puntos, para su uso al imprimir.
setTopMargin(topMargin)	Margen superior de la hoja de cálculo, en puntos, para su uso al imprimir.
setZoom(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 = ...`).

Detalles del método

getBlackAndWhite()

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

getBlackAndWhite(): boolean;

Devoluciones

boolean

getBottomMargin()

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

getBottomMargin(): number;

Devoluciones

number

getCenterHorizontally()

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.

getCenterHorizontally(): boolean;

Devoluciones

boolean

getCenterVertically()

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.

getCenterVertically(): boolean;

Devoluciones

boolean

getDraftMode()

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

getDraftMode(): boolean;

Devoluciones

boolean

getFirstPageNumber()

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".

getFirstPageNumber(): number | "";

Devoluciones

number | ""

getFooterMargin()

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

getFooterMargin(): number;

Devoluciones

number

getHeaderMargin()

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

getHeaderMargin(): number;

Devoluciones

number

getHeadersFooters()

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

getHeadersFooters(): HeaderFooterGroup;

Devoluciones

ExcelScript.HeaderFooterGroup

getLeftMargin()

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

getLeftMargin(): number;

Devoluciones

number

getOrientation()

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

getOrientation(): PageOrientation;

Devoluciones

ExcelScript.PageOrientation

getPaperSize()

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

getPaperSize(): PaperType;

Devoluciones

ExcelScript.PaperType

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, este método devuelve undefined.

getPrintArea(): RangeAreas;

Devoluciones

ExcelScript.RangeAreas

getPrintComments()

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

getPrintComments(): PrintComments;

Devoluciones

ExcelScript.PrintComments

getPrintErrors()

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

getPrintErrors(): PrintErrorType;

Devoluciones

ExcelScript.PrintErrorType

getPrintGridlines()

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

getPrintGridlines(): boolean;

Devoluciones

boolean

getPrintHeadings()

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

getPrintHeadings(): boolean;

Devoluciones

boolean

getPrintOrder()

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.

getPrintOrder(): PrintOrder;

Devoluciones

ExcelScript.PrintOrder

getPrintTitleColumns()

Obtiene el objeto de intervalo que representa las columnas de título. Si no se establece, este método devuelve undefined.

getPrintTitleColumns(): Range;

Devoluciones

ExcelScript.Range

getPrintTitleRows()

Obtiene el objeto de intervalo que representa las filas de título. Si no se establece, este método devuelve undefined.

getPrintTitleRows(): Range;

Devoluciones

ExcelScript.Range

getRightMargin()

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

getRightMargin(): number;

Devoluciones

number

getTopMargin()

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

getTopMargin(): number;

Devoluciones

number

getZoom()

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 = ...).

getZoom(): PageLayoutZoomOptions;

Devoluciones

ExcelScript.PageLayoutZoomOptions

setBlackAndWhite(blackAndWhite)

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

setBlackAndWhite(blackAndWhite: boolean): void;

Parámetros

blackAndWhite: boolean

Devoluciones

void

setBottomMargin(bottomMargin)

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

setBottomMargin(bottomMargin: number): void;

Parámetros

bottomMargin: number

Devoluciones

void

setCenterHorizontally(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.

setCenterHorizontally(centerHorizontally: boolean): void;

Parámetros

centerHorizontally: boolean

Devoluciones

void

setCenterVertically(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.

setCenterVertically(centerVertically: boolean): void;

Parámetros

centerVertically: boolean

Devoluciones

void

setDraftMode(draftMode)

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

setDraftMode(draftMode: boolean): void;

Parámetros

draftMode: boolean

Devoluciones

void

Ejemplos

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

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".

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

Parámetros

firstPageNumber: number | ""

Devoluciones

void

setFooterMargin(footerMargin)

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

setFooterMargin(footerMargin: number): void;

Parámetros

footerMargin: number

Devoluciones

void

setHeaderMargin(headerMargin)

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

setHeaderMargin(headerMargin: number): void;

Parámetros

headerMargin: number

Devoluciones

void

setLeftMargin(leftMargin)

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

setLeftMargin(leftMargin: number): void;

Parámetros

leftMargin: number

Devoluciones

void

setOrientation(orientation)

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

setOrientation(orientation: PageOrientation): void;

Parámetros

orientation: ExcelScript.PageOrientation

Devoluciones

void

Ejemplos

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

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

setPaperSize(paperSize: PaperType): void;

Parámetros

paperSize: ExcelScript.PaperType

Devoluciones

void

Ejemplos

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

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

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

Parámetros

printArea: ExcelScript.Range | ExcelScript.RangeAreas | string

Intervalo o intervalos del contenido que se va a imprimir.

Devoluciones

void

setPrintComments(printComments)

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

setPrintComments(printComments: PrintComments): void;

Parámetros

printComments: ExcelScript.PrintComments

Devoluciones

void

Ejemplos

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

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

setPrintErrors(printErrors: PrintErrorType): void;

Parámetros

printErrors: ExcelScript.PrintErrorType

Devoluciones

void

setPrintGridlines(printGridlines)

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

setPrintGridlines(printGridlines: boolean): void;

Parámetros

printGridlines: boolean

Devoluciones

void

setPrintHeadings(printHeadings)

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

setPrintHeadings(printHeadings: boolean): void;

Parámetros

printHeadings: boolean

Devoluciones

void

setPrintMargins(unit, marginOptions)

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

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

Parámetros

unit: ExcelScript.PrintMarginUnit

Unidad de medida para los márgenes proporcionados.

marginOptions: ExcelScript.PageLayoutMarginOptions

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

Devoluciones

void

setPrintOrder(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.

setPrintOrder(printOrder: PrintOrder): void;

Parámetros

printOrder: ExcelScript.PrintOrder

Devoluciones

void

Ejemplos

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

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: ExcelScript.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

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: ExcelScript.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

setRightMargin(rightMargin)

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

setRightMargin(rightMargin: number): void;

Parámetros

rightMargin: number

Devoluciones

void

setTopMargin(topMargin)

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

setTopMargin(topMargin: number): void;

Parámetros

topMargin: number

Devoluciones

void

setZoom(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 = ...).

setZoom(zoom: PageLayoutZoomOptions): void;

Parámetros

zoom: ExcelScript.PageLayoutZoomOptions

Devoluciones

void

Ejemplos

/**
 * This script changes the scale-to-fit of the page layout.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the current worksheet.
    const sheet = workbook.getActiveWorksheet();

    // Scale the layout to half size for printing.
    const layout = sheet.getPageLayout();
    const zoomOptions: ExcelScript.PageLayoutZoomOptions = {
        scale: 50
    }
    layout.setZoom(zoomOptions)
}

Compartir a través de

ExcelScript.PageLayout interface

Comentarios

Ejemplos

Métodos

Detalles del método

getBlackAndWhite()

Devoluciones

getBottomMargin()

Devoluciones

getCenterHorizontally()

Devoluciones

getCenterVertically()

Devoluciones

getDraftMode()

Devoluciones

getFirstPageNumber()

Devoluciones

getFooterMargin()

Devoluciones

getHeaderMargin()

Devoluciones

getHeadersFooters()

Devoluciones

getLeftMargin()

Devoluciones

getOrientation()

Devoluciones

getPaperSize()

Devoluciones

getPrintArea()

Devoluciones

getPrintComments()

Devoluciones

getPrintErrors()

Devoluciones

getPrintGridlines()

Devoluciones

getPrintHeadings()

Devoluciones

getPrintOrder()

Devoluciones

getPrintTitleColumns()

Devoluciones

getPrintTitleRows()

Devoluciones

getRightMargin()

Devoluciones

getTopMargin()

Devoluciones

getZoom()

Devoluciones

setBlackAndWhite(blackAndWhite)

Parámetros

Devoluciones

setBottomMargin(bottomMargin)

Parámetros

Devoluciones

setCenterHorizontally(centerHorizontally)

Parámetros

Devoluciones

setCenterVertically(centerVertically)

Parámetros

Devoluciones

setDraftMode(draftMode)

Parámetros

Devoluciones

Ejemplos

setFirstPageNumber(firstPageNumber)

Parámetros

Devoluciones

setFooterMargin(footerMargin)

Parámetros

Devoluciones

setHeaderMargin(headerMargin)

Parámetros

Devoluciones

setLeftMargin(leftMargin)

Parámetros

Devoluciones