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