Word.TableOfAuthorities class

表示Word文档中的引文目录。

扩展

注解

[ API 集:WordApiDesktop 1.4 ]

属性

bookmark

指定要从中收集颁发机构条目表的书签的名称。

category

指定要包含在颁发机构表中的条目的类别。 值 0 到 16 对应于“引文目录”对话框的“类别”框中列出的项。 若要了解如何通过Word UI 访问此功能,请参阅创建颁发机构表。

context

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

entrySeparator

指定最多 5 个字符的分隔符。 这出现在引文目录条目与其页码之间。

isCategoryHeaderIncluded

指定是否在颁发机构表中显示一组条目的类别名称。

isEntryFormattingKept

指定是否在表格中显示引文机构表中的条目及其格式。

isPassimUsed

指定是否将对在五个或更多页上重复的同一颁发机构的引用替换为“Passim”。

pageNumberSeparator

指定最多 5 个字符的分隔符。 这出现在授权机构表中的各个页面引用之间。

pageRangeSeparator

指定最多 5 个字符的分隔符。 这出现在引文目录的页范围之间。

range

获取此引文目录的文档部分。

sequenceName

指定颁发机构表的 序列 (SEQ) 字段 标识符。

sequenceSeparator

指定最多 5 个字符的分隔符。 这出现在授权机构表中的序列号和页码之间。

tabLeader

指定在引文目录的条目及其关联页码之间出现的前导字符。

方法

delete()

删除此颁发机构表。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

toJSON()

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

track()

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

untrack()

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

属性详细信息

bookmark

指定要从中收集颁发机构条目表的书签的名称。

bookmark: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.4 ]

category

指定要包含在颁发机构表中的条目的类别。 值 0 到 16 对应于“引文目录”对话框的“类别”框中列出的项。 若要了解如何通过Word UI 访问此功能,请参阅创建颁发机构表。

category: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

context

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

context: RequestContext;

属性值

entrySeparator

指定最多 5 个字符的分隔符。 这出现在引文目录条目与其页码之间。

entrySeparator: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.4 ]

isCategoryHeaderIncluded

指定是否在颁发机构表中显示一组条目的类别名称。

isCategoryHeaderIncluded: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.4 ]

isEntryFormattingKept

指定是否在表格中显示引文机构表中的条目及其格式。

isEntryFormattingKept: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.4 ]

isPassimUsed

指定是否将对在五个或更多页上重复的同一颁发机构的引用替换为“Passim”。

isPassimUsed: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.4 ]

pageNumberSeparator

指定最多 5 个字符的分隔符。 这出现在授权机构表中的各个页面引用之间。

pageNumberSeparator: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.4 ]

pageRangeSeparator

指定最多 5 个字符的分隔符。 这出现在引文目录的页范围之间。

pageRangeSeparator: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.4 ]

range

获取此引文目录的文档部分。

readonly range: Word.Range;

属性值

注解

[ API 集:WordApiDesktop 1.4 ]

sequenceName

指定颁发机构表的 序列 (SEQ) 字段 标识符。

sequenceName: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.4 ]

sequenceSeparator

指定最多 5 个字符的分隔符。 这出现在授权机构表中的序列号和页码之间。

sequenceSeparator: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.4 ]

tabLeader

指定在引文目录的条目及其关联页码之间出现的前导字符。

tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";

属性值

Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"

注解

[ API 集:WordApiDesktop 1.4 ]

方法详细信息

delete()

删除此颁发机构表。

delete(): void;

返回

void

注解

[ API 集:WordApiDesktop 1.4 ]

load(options)

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

load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities;

参数

options
Word.Interfaces.TableOfAuthoritiesLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Word.Interfaces.TableOfAuthoritiesUpdateData

一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

set(properties: Word.TableOfAuthorities): void;

参数

返回

void

toJSON()

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

toJSON(): Word.Interfaces.TableOfAuthoritiesData;

返回

track()

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

track(): Word.TableOfAuthorities;

返回

untrack()

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

untrack(): Word.TableOfAuthorities;

返回