Excel.PageBreak class
注解
使用方
示例
// 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
context
rowIndex
方法详细信息
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()
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;