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;