Word.Page class

包:

word

表示文档中的一页。 Page 对象管理页面布局和内容。

扩展

OfficeExtension.ClientObject

注解

[ API 集：WordApiDesktop 1.2 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
height	获取在“页面设置”对话框中定义的纸张的高度（以磅为单位）。
index	获取页面的索引。 页索引从 1 开始，独立于用户的自定义页码。
width	获取“页面设置”对话框中定义的纸张的宽度（以磅为单位）。

方法

getNext()	获取窗格中的下一页。 ItemNotFound如果此页是最后一页，则引发错误。
getNextOrNullObject()	获取下一页。 如果此页是最后一页，则此方法将返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getRange(rangeLocation)	获取整个页面，或者页面的起始点或终点作为范围。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.Page对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.PageData) ，其中包含从原始对象加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

属性详细信息

context

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

context: RequestContext;

属性值

Word.RequestContext

height

获取在“页面设置”对话框中定义的纸张的高度（以磅为单位）。

readonly height: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

index

获取页面的索引。 页索引从 1 开始，独立于用户的自定义页码。

readonly index: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

width

获取“页面设置”对话框中定义的纸张的宽度（以磅为单位）。

readonly width: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

方法详细信息

getNext()

获取窗格中的下一页。 ItemNotFound如果此页是最后一页，则引发错误。

getNext(): Word.Page;

返回

Word.Page

注解

[ API 集：WordApiDesktop 1.2 ]

getNextOrNullObject()

获取下一页。 如果此页是最后一页，则此方法将返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getNextOrNullObject(): Word.Page;

返回

Word.Page

注解

[ API 集：WordApiDesktop 1.2 ]

getRange(rangeLocation)

获取整个页面，或者页面的起始点或终点作为范围。

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;

参数

rangeLocation

whole | start | end | "Whole" | "Start" | "End"

可选。 范围位置必须为“Whole”、“Start”或“End”。

返回

Word.Range

注解

[ API 集：WordApiDesktop 1.2 ]

load(options)

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

load(options?: Word.Interfaces.PageLoadOptions): Word.Page;

参数

options

Word.Interfaces.PageLoadOptions

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

返回

Word.Page

load(propertyNames)

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

load(propertyNames?: string | string[]): Word.Page;

参数

propertyNames

string | string[]

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

返回

Word.Page

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Page;

参数

propertyNamesAndPaths

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

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

返回

Word.Page

toJSON()

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

toJSON(): Word.Interfaces.PageData;

返回

Word.Interfaces.PageData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.Page;

返回

Word.Page

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.Page;

返回

Word.Page