Word.TableOfContentsAddOptions interface

指定用于添加到Word的选项。TableOfContentsCollection 对象。

注解

[ API 集:WordApiDesktop 1.4 ]

属性

addedStyles

如果提供,则指定要用于目录的其他样式的字符串名称。 使用 HeadingStyleCollection.add 创建新的标题样式。

hidePageNumbersOnWeb

如果提供,则指定在发布到 Web 时是否应隐藏目录中的页码。 默认值 true为 。

includePageNumbers

如果提供,则指定是否在目录中包括页码。 默认值 true为 。

lowerHeadingLevel

如果提供,则指定目录的结束标题级别,并且必须是 1 到 9 的值。 必须大于 upperHeadingLevel。 对应于目录 (目录) 字段的开关使用的\o结束值。 默认值 9为 。

rightAlignPageNumbers

如果提供,则指定目录中的页码是否与右边距对齐。 默认值 true为 。

tableId

如果提供,则指定用于目录的 TC 字段中 的一个字母标识符。 \f对应于目录 (目录) 字段的开关。 例如,“T”指示目录包含使用表标识符 T 的 TC 字段。如果省略此参数,则不使用 TC 字段。

upperHeadingLevel

如果提供,则指定目录的起始标题级别,并且必须是 1 到 9 的值。 应小于 lowerHeadingLevel。 对应于目录 (目录) 字段的开关使用的\o起始值。 默认值 1为 。

useBuiltInHeadingStyles

如果提供,则指定是否使用内置标题样式来创建目录。 默认值 true为 。

useFields

如果提供,则指定是否使用 目录项 (TC) 字段 来创建目录。 使用 TableOfContentsCollection.markTocEntry 方法可标记要包含在目录中的条目。 默认值 false为 。

useHyperlinksOnWeb

如果提供,则指定在将文档发布到 Web 时,是否应将目录中的条目格式化为超链接。 默认值 true为 。

useOutlineLevels

如果提供,则指定是否使用大纲级别创建目录。 默认值 false为 。

属性详细信息

addedStyles

如果提供,则指定要用于目录的其他样式的字符串名称。 使用 HeadingStyleCollection.add 创建新的标题样式。

addedStyles?: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.4 ]

hidePageNumbersOnWeb

如果提供,则指定在发布到 Web 时是否应隐藏目录中的页码。 默认值 true为 。

hidePageNumbersOnWeb?: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.4 ]

includePageNumbers

如果提供,则指定是否在目录中包括页码。 默认值 true为 。

includePageNumbers?: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.4 ]

lowerHeadingLevel

如果提供,则指定目录的结束标题级别,并且必须是 1 到 9 的值。 必须大于 upperHeadingLevel。 对应于目录 (目录) 字段的开关使用的\o结束值。 默认值 9为 。

lowerHeadingLevel?: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

rightAlignPageNumbers

如果提供,则指定目录中的页码是否与右边距对齐。 默认值 true为 。

rightAlignPageNumbers?: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.4 ]

tableId

如果提供,则指定用于目录的 TC 字段中 的一个字母标识符。 \f对应于目录 (目录) 字段的开关。 例如,“T”指示目录包含使用表标识符 T 的 TC 字段。如果省略此参数,则不使用 TC 字段。

tableId?: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.4 ]

upperHeadingLevel

如果提供,则指定目录的起始标题级别,并且必须是 1 到 9 的值。 应小于 lowerHeadingLevel。 对应于目录 (目录) 字段的开关使用的\o起始值。 默认值 1为 。

upperHeadingLevel?: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

useBuiltInHeadingStyles

如果提供,则指定是否使用内置标题样式来创建目录。 默认值 true为 。

useBuiltInHeadingStyles?: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.4 ]

useFields

如果提供,则指定是否使用 目录项 (TC) 字段 来创建目录。 使用 TableOfContentsCollection.markTocEntry 方法可标记要包含在目录中的条目。 默认值 false为 。

useFields?: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.4 ]

useHyperlinksOnWeb

如果提供,则指定在将文档发布到 Web 时,是否应将目录中的条目格式化为超链接。 默认值 true为 。

useHyperlinksOnWeb?: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.4 ]

useOutlineLevels

如果提供,则指定是否使用大纲级别创建目录。 默认值 false为 。

useOutlineLevels?: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.4 ]