Excel.PageBreakCollection class

Пакет:: excel

Extends: OfficeExtension.ClientObject

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

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
items	Получает загруженные дочерние элементы в этой коллекции.

Методы

add(pageBreakRange)	Добавляет разрыв страницы перед левой верхней ячейкой указанного диапазона.
getCount()	Получает количество разрывов страниц в коллекции.
getItem(index)	Получает объект разрыва страницы по индексу.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
removePageBreaks()	Сбрасывает все добавленные вручную разрывы страниц в коллекции.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.PageBreakCollection` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Excel.Interfaces.PageBreakCollectionData`), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

Сведения о свойстве

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.PageBreak[];

Значение свойства

Excel.PageBreak[]

Сведения о методе

add(pageBreakRange)

Добавляет разрыв страницы перед левой верхней ячейкой указанного диапазона.

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

Параметры

pageBreakRange: Excel.Range | string

Диапазон сразу после разрыва страницы, который необходимо добавить.

Возвращаемое значение

Excel.PageBreak

Примеры

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

Получает количество разрывов страниц в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

Возвращаемое значение

OfficeExtension.ClientResult<number>

Примеры

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

Получает объект разрыва страницы по индексу.

getItem(index: number): Excel.PageBreak;

Параметры

index: number

Индекс разрыва страницы.

Возвращаемое значение

Excel.PageBreak

Примеры

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

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

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

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Excel.PageBreakCollection

load(propertyNames)

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

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Excel.PageBreakCollection

load(propertyNamesAndPaths)

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

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Excel.PageBreakCollection

removePageBreaks()

Сбрасывает все добавленные вручную разрывы страниц в коллекции.

removePageBreaks(): void;

Возвращаемое значение

void

Примеры

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

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.PageBreakCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.PageBreakCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

toJSON(): Excel.Interfaces.PageBreakCollectionData;

Возвращаемое значение

Excel.Interfaces.PageBreakCollectionData

Обратная связь

Были ли сведения на этой странице полезными?

Комментарии

Используется

Примеры

Свойства

Методы

context

Значение свойства

items

Значение свойства

add(pageBreakRange)

Параметры

Возвращаемое значение

Комментарии

Примеры

getCount()

Возвращаемое значение

Комментарии

Примеры

getItem(index)

Параметры

Возвращаемое значение

Комментарии

Примеры

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

removePageBreaks()

Возвращаемое значение

Комментарии

Примеры

toJSON()

Возвращаемое значение