Word.TableOfAuthoritiesCollection class
表示Word的集合。Word文档中的 TableOfAuthorities 对象。
注解
方法
| add(range, options) | 向文档添加指定范围的引文表。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| mark |
在指定引文文本的所有实例之后插入 ta) 字段 ( 引文条目表。 |
| mark |
在指定范围 (TA) 字段插入引文目录 。 |
| select |
查找并选择指定引文文本的下一个实例。 |
| toJSON() | 重写 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 |
| untrack() | 释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前,需要调用 |
属性详细信息
context
items
方法详细信息
add(range, options)
向文档添加指定范围的引文表。
add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions): Word.TableOfAuthorities;
参数
- range
- Word.Range
颁发机构表的显示范围。 如果范围未折叠,则引文目录将替换范围。
可选。 用于配置颁发机构表的选项。
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCollection;
参数
- options
-
Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCollection;
参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCollection;
参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。
返回
markAllCitations(shortCitation, options)
在指定引文文本的所有实例之后插入 ta) 字段 ( 引文条目表。
markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): void;
参数
- shortCitation
-
string
要标记的引文文本。
可选。 用于标记引文的选项。
返回
void
注解
markCitation(range, shortCitation, options)
在指定范围 (TA) 字段插入引文目录 。
markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): Word.Field;
参数
- range
- Word.Range
将插入引文的范围。
- shortCitation
-
string
简短的引文文本。
可选。 用于标记引文的选项。
返回
注解
selectNextCitation(shortCitation)
查找并选择指定引文文本的下一个实例。
selectNextCitation(shortCitation: string): void;
参数
- shortCitation
-
string
要搜索的引文文本。
返回
void
注解
toJSON()
重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(,反过来,调用toJSON传递给它的 对象的 方法。) 而原始Word.TableOfAuthoritiesCollection对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Word.Interfaces.TableOfAuthoritiesCollectionData) ,其中包含一个“items”数组,其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Word.Interfaces.TableOfAuthoritiesCollectionData;
返回
track()
根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象,并在设置属性或调用对象方法时收到“InvalidObjectPath”错误,则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分,则还应跟踪父集合。
track(): Word.TableOfAuthoritiesCollection;
返回
untrack()
释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前,需要调用 context.sync() 。
untrack(): Word.TableOfAuthoritiesCollection;