Excel.PageBreak class
- Extends
Comentarios
Usada por
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml
// Inspect the first horizontal break and locate the cell immediately after it.
await Excel.run(async (context) => {
const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
const horizontalCount: OfficeExtension.ClientResult<number> = horizontalBreaks.getCount();
await context.sync();
if (horizontalCount.value === 0) {
console.warn("No horizontal page breaks. Choose Add page breaks first.");
return;
}
const firstBreak: Excel.PageBreak = horizontalBreaks.getItem(0);
const cellAfterBreak: Excel.Range = firstBreak.getCellAfterBreak();
firstBreak.load("rowIndex, columnIndex");
cellAfterBreak.load("address");
await context.sync();
console.log("First horizontal page break (zero-based indexes):", {
rowIndex: firstBreak.rowIndex,
columnIndex: firstBreak.columnIndex,
cellAfterBreak: cellAfterBreak.address
});
});
Propiedades
| column |
Especifica el índice de columna para el salto de página. |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| row |
Especifica el índice de fila del salto de página. |
Métodos
| delete() | Elimina un objeto de salto de página. |
| get |
Obtiene la primera celda después del salto de página. |
| 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 |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
columnIndex
Especifica el índice de columna para el salto de página.
readonly columnIndex: number;Valor de propiedad
number
Comentarios
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
rowIndex
Especifica el índice de fila del salto de página.
readonly rowIndex: number;Valor de propiedad
number
Comentarios
Detalles del método
delete()
Elimina un objeto de salto de página.
delete(): void;Devoluciones
void
Comentarios
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml
// Delete a single horizontal break while leaving the other breaks unchanged.
await Excel.run(async (context) => {
const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
const horizontalCount: OfficeExtension.ClientResult<number> = horizontalBreaks.getCount();
await context.sync();
if (horizontalCount.value === 0) {
console.warn("No horizontal page breaks. Choose Add page breaks first.");
return;
}
const firstBreak: Excel.PageBreak = horizontalBreaks.getItem(0);
firstBreak.delete();
await context.sync();
console.log("Deleted the first horizontal page break. Choose List page breaks to inspect the remaining breaks.");
});
getCellAfterBreak()
Obtiene la primera celda después del salto de página.
getCellAfterBreak(): 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.PageBreakLoadOptions): Excel.PageBreak;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.PageBreak;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.PageBreak;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
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.PageBreak es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.PageBreakData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.PageBreakData;