Excel.PageBreakCollection class

Pacote:: excel

Extends: OfficeExtension.ClientObject

Comentários

Usada por

Excel.Worksheet: horizontalPageBreaks, verticalPageBreaks

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml

// Load and inspect the page breaks in both worksheet collections.
await Excel.run(async (context) => {
    const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
    const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
    const verticalBreaks: Excel.PageBreakCollection = sheet.verticalPageBreaks;
    horizontalBreaks.load("items/rowIndex, items/columnIndex");
    verticalBreaks.load("items/rowIndex, items/columnIndex");

    await context.sync();
    console.log(`Horizontal page breaks: ${horizontalBreaks.items.length}`);
    horizontalBreaks.items.forEach((pageBreak: Excel.PageBreak) => {
        console.log("Horizontal break (zero-based indexes):", {
            rowIndex: pageBreak.rowIndex,
            columnIndex: pageBreak.columnIndex
        });
    });
    console.log(`Vertical page breaks: ${verticalBreaks.items.length}`);
    verticalBreaks.items.forEach((pageBreak: Excel.PageBreak) => {
        console.log("Vertical break (zero-based indexes):", {
            rowIndex: pageBreak.rowIndex,
            columnIndex: pageBreak.columnIndex
        });
    });
});

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

add(pageBreakRange)	Adiciona uma quebra de página antes da célula superior esquerda do intervalo especificado.
getCount()	Obtém o número de quebras de página na coleção.
getItem(index)	Obtém um objeto de quebra de página através do índice.
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(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
removePageBreaks()	Redefine todas as quebras de página manuais na coleção.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`, por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o objeto original `Excel.PageBreakCollection` é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Excel.Interfaces.PageBreakCollectionData`) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.

Detalhes da propriedade

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

Excel.RequestContext

items

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.PageBreak[];

Valor da propriedade

Excel.PageBreak[]

Detalhes do método

add(pageBreakRange)

Adiciona uma quebra de página antes da célula superior esquerda do intervalo especificado.

add(pageBreakRange: Range | string): Excel.PageBreak;

Parâmetros

pageBreakRange: Excel.Range | string

O intervalo imediatamente após a quebra de página a ser adicionada.

Retornos

Excel.PageBreak

Comentários

Conjunto de APIs: 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

// Add a horizontal page break before the next group of farm sales.
await Excel.run(async (context) => {
    const farmSheet: Excel.Worksheet = context.workbook.worksheets.getItem("Print");
    const horizontalBreaks: Excel.PageBreakCollection = farmSheet.horizontalPageBreaks;
    horizontalBreaks.add("A21:E21");
    await context.sync();
    console.log("Added a horizontal page break before row 21.");
});

getCount()

Obtém o número de quebras de página na coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml

// Count page breaks without loading the collection's items.
await Excel.run(async (context) => {
    const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
    const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
    const verticalBreaks: Excel.PageBreakCollection = sheet.verticalPageBreaks;
    const horizontalCount: OfficeExtension.ClientResult<number> = horizontalBreaks.getCount();
    const verticalCount: OfficeExtension.ClientResult<number> = verticalBreaks.getCount();

    await context.sync();
    console.log(`Horizontal page breaks: ${horizontalCount.value}`);
    console.log(`Vertical page breaks: ${verticalCount.value}`);
});

getItem(index)

Obtém um objeto de quebra de página através do índice.

getItem(index: number): Excel.PageBreak;

Parâmetros

index: number

Índice da quebra de página.

Retornos

Excel.PageBreak

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

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

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.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection;

Parâmetros

options: Excel.Interfaces.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Excel.PageBreakCollection

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.PageBreakCollection;

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

Excel.PageBreakCollection

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?: OfficeExtension.LoadOption): Excel.PageBreakCollection;

Parâmetros

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.PageBreakCollection

removePageBreaks()

Redefine todas as quebras de página manuais na coleção.

removePageBreaks(): void;

Retornos

void

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml

// Reset all manual page breaks in both worksheet collections.
await Excel.run(async (context) => {
    const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
    const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
    const verticalBreaks: Excel.PageBreakCollection = sheet.verticalPageBreaks;
    horizontalBreaks.removePageBreaks();
    verticalBreaks.removePageBreaks();

    await context.sync();
    console.log("Removed all manual page breaks. Choose Count page breaks to verify the collections.");
});

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.PageBreakCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.PageBreakCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.PageBreakCollectionData;

Retornos

Excel.Interfaces.PageBreakCollectionData

Comentários

Esta página foi útil?