Excel.PageBreak class

  • 参考
包:
excel
Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.9 ]

属性

columnIndex

指定分页符的列索引。
context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
rowIndex

指定分页符的行索引。

方法

delete()

删除分页符对象。
getCellAfterBreak()

获取分页符后的第一个单元格。
load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始 Excel.PageBreak 对象是 API 对象，但toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.PageBreakData) ，该对象包含原始对象中加载的任何子属性的浅表副本。

属性详细信息

columnIndex

指定分页符的列索引。

readonly columnIndex: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

rowIndex

指定分页符的行索引。

readonly rowIndex: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

delete()

删除分页符对象。

delete(): void;

返回

void

注解

[ API 集：ExcelApi 1.9 ]

getCellAfterBreak()

获取分页符后的第一个单元格。

getCellAfterBreak(): Excel.Range;

返回

Excel.Range

注解

[ API 集：ExcelApi 1.9 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak;

参数

options
Excel.Interfaces.PageBreakLoadOptions

提供要加载对象的属性的选项。

返回

Excel.PageBreak

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.PageBreak

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.PageBreak;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.PageBreak

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始 Excel.PageBreak 对象是 API 对象，但toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.PageBreakData) ，该对象包含原始对象中加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.PageBreakData;

返回

Excel.Interfaces.PageBreakData