Excel.PageBreak class
- Extends
Комментарии
Используется
Примеры
// 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
});
});
Свойства
| column |
Индекс столбца для разрыва страницы. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| row |
Указывает индекс строки для разрыва страницы. |
Методы
| delete() | Удаляет объект разрыва страницы. |
| get |
Получает первую ячейку после разрыва страницы. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
columnIndex
Индекс столбца для разрыва страницы.
readonly columnIndex: number;Значение свойства
number
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
rowIndex
Указывает индекс строки для разрыва страницы.
readonly rowIndex: number;Значение свойства
number
Комментарии
Сведения о методе
delete()
Удаляет объект разрыва страницы.
delete(): void;Возвращаемое значение
void
Комментарии
Примеры
// 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()
Получает первую ячейку после разрыва страницы.
getCellAfterBreak(): Excel.Range;Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.PageBreak;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.PageBreak;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.PageBreak объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.PageBreakData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.PageBreakData;