Excel.PageLayout class
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
Comentarios
[ Conjunto de API: ExcelApi 1.9 ]
Propiedades
| black |
Opción de impresión en blanco y negro de la hoja de cálculo. |
| bottom |
Margen de página inferior de la hoja de cálculo que se va a usar para imprimir en puntos. |
| center |
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. |
| center |
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. |
| draft |
Opción de modo de borrador de la hoja de cálculo. Si |
| first |
Primer número de página de la hoja de cálculo que se va a imprimir. Un |
| footer |
Margen de pie de página de la hoja de cálculo, en puntos, para su uso al imprimir. |
| header |
Margen de encabezado de la hoja de cálculo, en puntos, para su uso al imprimir. |
| headers |
Configuración de encabezado y pie de página de la hoja de cálculo. |
| left |
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. |
| paper |
Tamaño de papel de la hoja de cálculo de la página. |
| print |
Especifica si se deben mostrar los comentarios de la hoja de cálculo al imprimir. |
| print |
Opción de errores de impresión de la hoja de cálculo. |
| print |
Especifica si se imprimirán las líneas de cuadrícula de la hoja de cálculo. |
| print |
Especifica si se imprimirán los encabezados de la hoja de cálculo. |
| print |
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. |
| right |
Margen derecho de la hoja de cálculo, en puntos, para su uso al imprimir. |
| top |
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 |
Métodos
| get |
Obtiene el |
| get |
Obtiene el |
| get |
Obtiene el objeto de intervalo que representa las columnas de título. |
| get |
Obtiene el objeto de intervalo que representa las columnas de título. Si no se establece, este método devuelve un objeto con su |
| get |
Obtiene el objeto de intervalo que representa las filas de título. |
| get |
Obtiene el objeto de intervalo que representa las filas de título. Si no se establece, este método devuelve un objeto con su |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| 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. |
| set |
Establece el área de impresión de la hoja de cálculo. |
| set |
Establece los márgenes de página de la hoja de cálculo con unidades. |
| set |
Establece los márgenes de página de la hoja de cálculo con unidades. |
| set |
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. |
| set |
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 |
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
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
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
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
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
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
headerMargin
Margen de encabezado de la hoja de cálculo, en puntos, para su uso al imprimir.
headerMargin: number;Valor de propiedad
number
Comentarios
headersFooters
Configuración de encabezado y pie de página de la hoja de cálculo.
readonly headersFooters: Excel.HeaderFooterGroup;Valor de propiedad
Comentarios
leftMargin
Margen izquierdo de la hoja de cálculo, en puntos, para su uso al imprimir.
leftMargin: number;Valor de propiedad
number
Comentarios
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
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
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
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
printHeadings
Especifica si se imprimirán los encabezados de la hoja de cálculo.
printHeadings: boolean;Valor de propiedad
boolean
Comentarios
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
rightMargin
Margen derecho de la hoja de cálculo, en puntos, para su uso al imprimir.
rightMargin: number;Valor de propiedad
number
Comentarios
topMargin
Margen superior de la hoja de cálculo, en puntos, para su uso al imprimir.
topMargin: number;Valor de propiedad
number
Comentarios
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
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
Comentarios
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
Comentarios
getPrintTitleColumns()
Obtiene el objeto de intervalo que representa las columnas de título.
getPrintTitleColumns(): Excel.Range;Devoluciones
Comentarios
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
Comentarios
getPrintTitleRows()
Obtiene el objeto de intervalo que representa las filas de título.
getPrintTitleRows(): Excel.Range;Devoluciones
Comentarios
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
Comentarios
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
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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
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
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
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
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
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
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 Excel.PageLayout original 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
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de