Excel.PageBreakCollection class

Paket:: excel

Extends: OfficeExtension.ClientObject

Hinweise

Verwendet von

Excel.Worksheet: horizontalPageBreaks, verticalPageBreaks

Beispiele

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

Eigenschaften

context	Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
items	Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

add(pageBreakRange)	Fügt vor der oberen linken Zelle des angegebenen Bereichs einen Seitenumbruch hinzu.
getCount()	Ruft die Anzahl der Seitenumbrüche in der Sammlung ab.
getItem(index)	Ruft ein Seitenumbruchobjekt über den Index ab.
load(options)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
load(propertyNames)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
load(propertyNamesAndPaths)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
removePageBreaks()	Setzt alle manuellen Seitenumbrüche in der Sammlung zurück.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche `Excel.PageBreakCollection` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `Excel.Interfaces.PageBreakCollectionData`) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.

Details zur Eigenschaft

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.PageBreak[];

Eigenschaftswert

Excel.PageBreak[]

Details zur Methode

add(pageBreakRange)

Fügt vor der oberen linken Zelle des angegebenen Bereichs einen Seitenumbruch hinzu.

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

Parameter

pageBreakRange: Excel.Range | string

Der hinzuzufügende Bereich unmittelbar nach dem Seitenumbruch.

Gibt zurück

Excel.PageBreak

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

Ruft die Anzahl der Seitenumbrüche in der Sammlung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

Ruft ein Seitenumbruchobjekt über den Index ab.

getItem(index: number): Excel.PageBreak;

Parameter

index: number

Index des Seitenumbruchs.

Gibt zurück

Excel.PageBreak

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection;

Parameter

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

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

Excel.PageBreakCollection

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.PageBreakCollection

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PageBreakCollection;

Parameter

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.PageBreakCollection

removePageBreaks()

Setzt alle manuellen Seitenumbrüche in der Sammlung zurück.

removePageBreaks(): void;

Gibt zurück

void

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.PageBreakCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.PageBreakCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.

toJSON(): Excel.Interfaces.PageBreakCollectionData;

Gibt zurück

Excel.Interfaces.PageBreakCollectionData

Feedback

War diese Seite hilfreich?