Word.TableOfFigures class
表示Word文档中的图表表。
注解
属性
| additional |
获取用于图表表的其他样式。 此集合中不包含默认的“标题 1”-“标题 9”样式。 |
| are |
指定是否对图表表使用内置标题样式。 |
| are |
指定目录 项 (TC) 字段 是否包含在图表表中。 |
| are |
指定在发布到 Web 时，是否应将图表表中的条目格式化为超链接。 |
| are |
指定在发布到 Web 时是否应隐藏图表表中的页码。 |
| are |
指定是否在图表表中包括页码。 |
| are |
指定页码是否与图表表中的右边距对齐。 |
| caption |
指定标识要包含在图表表中的项的标签。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| is |
指定描述文字标签和描述文字编号是否包含在图表表中。 |
| lower |
指定图表表的结束标题级别。 必须是 1 到 9 且大于 |
| range | 获取文档的此图表表部分。 |
| tab |
指定图表表中条目与其页码之间的字符。 |
| table |
指定用于图表表的 TC 字段中 的一个字母标识符。 |
| upper |
指定图表表的起始标题级别。 必须是 1 到 9 且小于 |
方法
| delete() | 删除此图表表。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 |
| update |
汇报整个图表表。 |
属性详细信息
additionalHeadingStyles
获取用于图表表的其他样式。 此集合中不包含默认的“标题 1”-“标题 9”样式。
readonly additionalHeadingStyles: Word.HeadingStyleCollection;属性值
注解
areBuiltInHeadingStylesUsed
areFieldsUsed
areHyperlinksUsedOnWeb
指定在发布到 Web 时，是否应将图表表中的条目格式化为超链接。
areHyperlinksUsedOnWeb: boolean;属性值
boolean
注解
arePageNumbersHiddenOnWeb
指定在发布到 Web 时是否应隐藏图表表中的页码。
arePageNumbersHiddenOnWeb: boolean;属性值
boolean
注解
arePageNumbersIncluded
arePageNumbersRightAligned
captionLabel
context
isLabelIncluded
lowerHeadingLevel
指定图表表的结束标题级别。 必须是 1 到 9 且大于 upperHeadingLevel的值。
lowerHeadingLevel: number;属性值
number
注解
range
tabLeader
指定图表表中条目与其页码之间的字符。
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";属性值
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
注解
tableId
upperHeadingLevel
指定图表表的起始标题级别。 必须是 1 到 9 且小于 lowerHeadingLevel的值。
upperHeadingLevel: number;属性值
number
注解
方法详细信息
delete()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.TableOfFiguresLoadOptions): Word.TableOfFigures;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.TableOfFigures;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableOfFigures;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.TableOfFiguresUpdateData
一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
基于现有的已加载对象，同时对对象设置多个属性。
set(properties: Word.TableOfFigures): void;参数
- properties
- Word.TableOfFigures
返回
void
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.TableOfFigures对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.TableOfFiguresData) ，其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Word.Interfaces.TableOfFiguresData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。
track(): Word.TableOfFigures;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。
untrack(): Word.TableOfFigures;