Word.TableOfFiguresAddOptions interface
指定用于添加到 Word 的选项。TableOfFiguresCollection 对象。
注解
使用方
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/42-reference-tables/table-of-figures.yaml
// Adds a table of figures at the start of the document.
await Word.run(async (context) => {
const documentBody: Word.Body = context.document.body;
const tablesOfFigures: Word.TableOfFiguresCollection = context.document.tablesOfFigures;
const insertionRange: Word.Range = documentBody.getRange(Word.RangeLocation.start);
const tableOptions: Word.TableOfFiguresAddOptions = {
captionLabel: "Figure",
includeLabel: true,
includePageNumbers: true,
rightAlignPageNumbers: true,
tableId: "F",
useFields: true,
};
const tableOfFigures: Word.TableOfFigures = tablesOfFigures.add(insertionRange, tableOptions);
await context.sync();
console.log("Created a table of figures.");
});
属性
| added |
如果提供，则指定要用于图表表格的其他样式的字符串名称。 |
| caption |
如果提供，则指定标识要包含在图表表格中的项目的标签。 对应于 |
| hide |
如果提供，则指定在发布到 Web 时是否应隐藏图表表中的页码。 默认值为 |
| include |
如果提供，则指定是否在图表表中包括描述文字标签和描述文字编号。 默认值为 |
| include |
如果提供，则指定图表中是否包含页码。 默认值为 |
| lower |
如果提供，则在设置为 |
| right |
如果提供，则指定页码是否与图表中的右边距对齐。 默认值为 |
| table |
如果提供，则指定用于图表表的 TC 字段 中的一个字母标识符。 对应于 |
| upper |
如果提供，则在设置为 |
| use |
如果提供，则指定是否使用内置标题样式创建图表表格。 默认值为 |
| use |
如果提供，则指定是否使用“ 目录条目” (“TC) ”字段 创建图表目录。 使用 TableOfFiguresCollection.markTocEntry 方法标记要包含在图表表格中的条目。 默认值为 |
| use |
如果提供，则指定在文档发布到 Web 时是否应将图表表中的条目格式设置为超链接。 默认值为 |
属性详细信息
addedStyles
captionLabel
如果提供，则指定标识要包含在图表表格中的项目的标签。 对应于 \c 目录 (TOC) 字段的开关。 默认值为“Figure”。
captionLabel?: string;属性值
string
注解
hidePageNumbersOnWeb
如果提供，则指定在发布到 Web 时是否应隐藏图表表中的页码。 默认值为 true。
hidePageNumbersOnWeb?: boolean;属性值
boolean
注解
includeLabel
如果提供，则指定是否在图表表中包括描述文字标签和描述文字编号。 默认值为 true。
includeLabel?: boolean;属性值
boolean
注解
includePageNumbers
lowerHeadingLevel
如果提供，则在设置为 true时指定图表useBuiltInHeadingStyles的结束标题级别。 应是 1 到 9 之间的值，且大于 upperHeadingLevel。 对应于目录 (TOC) 字段开关使用的\o结束值。 默认值为 9。
lowerHeadingLevel?: number;属性值
number
注解
rightAlignPageNumbers
如果提供，则指定页码是否与图表中的右边距对齐。 默认值为 true。
rightAlignPageNumbers?: boolean;属性值
boolean
注解
tableId
upperHeadingLevel
如果提供，则在设置为 true时指定图表useBuiltInHeadingStyles表的起始标题级别。 应是 1 到 9 之间的值，且小于 lowerHeadingLevel。 对应于目录 (TOC) 字段开关使用的\o起始值。 默认值为 1。
upperHeadingLevel?: number;属性值
number
注解
useBuiltInHeadingStyles
如果提供，则指定是否使用内置标题样式创建图表表格。 默认值为 false。
useBuiltInHeadingStyles?: boolean;属性值
boolean
注解
useFields
如果提供，则指定是否使用“ 目录条目” (“TC) ”字段 创建图表目录。 使用 TableOfFiguresCollection.markTocEntry 方法标记要包含在图表表格中的条目。 默认值为 false。
useFields?: boolean;属性值
boolean
注解
useHyperlinksOnWeb
如果提供，则指定在文档发布到 Web 时是否应将图表表中的条目格式设置为超链接。 默认值为 true。
useHyperlinksOnWeb?: boolean;属性值
boolean