Word.HtmlDivision class

扩展

注解

[ API 集:WordApiDesktop 1.4 ]

属性

context

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

htmlDivisions
leftIndent

指定此 HTML 除法) (左缩进值(以磅为单位)。

range

获取一个 Range 对象,该对象表示此 HTML 分区中包含的文档部分。

rightIndent

指定此 HTML 划分的右缩进 ((以磅为单位) )。

spaceAfter

指定此 HTML 除法后) (磅的间距量。

spaceBefore

指定此 HTML 除法之前的间距 () 磅。

方法

delete()

删除此 HTML 划分。

htmlDivisionParent(levelsUp)

返回一个 HtmlDivision 对象,该对象代表当前 HTML 除法的父除法。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

track()

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

untrack()

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

属性详细信息

context

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

context: RequestContext;

属性值

htmlDivisions

readonly htmlDivisions: Word.HtmlDivisionCollection;

属性值

leftIndent

指定此 HTML 除法) (左缩进值(以磅为单位)。

leftIndent: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

range

获取一个 Range 对象,该对象表示此 HTML 分区中包含的文档部分。

readonly range: Word.Range;

属性值

注解

[ API 集:WordApiDesktop 1.4 ]

rightIndent

指定此 HTML 划分的右缩进 ((以磅为单位) )。

rightIndent: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

spaceAfter

指定此 HTML 除法后) (磅的间距量。

spaceAfter: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

spaceBefore

指定此 HTML 除法之前的间距 () 磅。

spaceBefore: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

方法详细信息

delete()

删除此 HTML 划分。

delete(): void;

返回

void

注解

[ API 集:WordApiDesktop 1.4 ]

htmlDivisionParent(levelsUp)

返回一个 HtmlDivision 对象,该对象代表当前 HTML 除法的父除法。

htmlDivisionParent(levelsUp?: number): Word.HtmlDivision;

参数

levelsUp

number

可选。 要向上检索父除法的级别数。

返回

注解

[ API 集:WordApiDesktop 1.4 ]

load(options)

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

load(options?: Word.Interfaces.HtmlDivisionLoadOptions): Word.HtmlDivision;

参数

options
Word.Interfaces.HtmlDivisionLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

toJSON()

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

toJSON(): Word.Interfaces.HtmlDivisionData;

返回

track()

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

track(): Word.HtmlDivision;

返回

untrack()

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

untrack(): Word.HtmlDivision;

返回