Word.HtmlDivision class

扩展

属性

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;

返回