FieldToc
遗产： java.lang.Object, com.aspose.words.Field
public class FieldToc extends Field
实现 TOC 字段。
要了解更多信息，请访问Working with Fields文档文章。
使用 TC 字段指定的条目、它们的标题级别和指定的样式构建目录（也可以是图表），并将该表插入到文档中的此位置。
方法
equals(Object arg0)
public boolean equals(Object arg0)
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| arg0 | java.lang.Object |
退货： 布尔值
getAreCustomStylesSpecified()
public boolean getAreCustomStylesSpecified()
退货： 布尔值
getBookmarkName()
public String getBookmarkName()
获取标记文档中用于构建表的部分的书签的名称。
退货： java.lang.String - 标记用于构建表的文档部分的书签的名称。
getCaptionlessTableOfFiguresLabel()
public String getCaptionlessTableOfFiguresLabel()
获取在构建不包括标题标签和数字的图形表时使用的序列标识符的名称。
退货： java.lang.String - 构建不包括标题标签和编号的图表时使用的序列标识符的名称。
getClass()
public final native Class<?> getClass()
退货： java.lang.Class
getCustomStyles()
public String getCustomStyles()
获取要包含在目录中的除内置标题样式之外的样式列表。
退货： java.lang.String - 要包含在目录中的内置标题样式以外的样式列表。
getDisplayResult()
public String getDisplayResult()
获取表示显示的字段结果的文本。这Document.updateListLabels()必须调用方法以获得正确的值FieldListNum, FieldAutoNum, FieldAutoNumOut和FieldAutoNumLgl字段。
退货： java.lang.String - 表示显示字段结果的文本。
getEnd()
public FieldEnd getEnd()
获取表示字段结束的节点。
退货： FieldEnd - 表示字段结束的节点。
getEntryIdentifier()
public String getEntryIdentifier()
获取一个字符串，该字符串应与包含的 TC 字段的类型标识符匹配。
退货： java.lang.String - 应与包含的 TC 字段的类型标识符相匹配的字符串。
getEntryLevelRange()
public String getEntryLevelRange()
获取要包含的目录条目的一系列级别。
退货： java.lang.String - 要包含的目录条目的级别范围。
getEntrySeparator()
public String getEntrySeparator()
获取分隔条目及其页码的字符序列。
退货： java.lang.String - 分隔条目及其页码的字符序列。
getEntryTypeCore()
public int getEntryTypeCore()
退货： 整数
getFieldCode()
public String getFieldCode()
返回字段开始和字段分隔符之间的文本（如果没有分隔符，则返回字段结束）。包括子字段的字段代码和字段结果。
退货： java.lang.字符串
getFieldCode(boolean includeChildFieldCodes)
public String getFieldCode(boolean includeChildFieldCodes)
返回字段开始和字段分隔符之间的文本（如果没有分隔符，则返回字段结束）。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| includeChildFieldCodes | boolean | { 如果应包含子域代码则为真。 |
退货： java.lang.字符串
getFormat()
public FieldFormat getFormat()
得到一个FieldFormat提供对字段格式的类型化访问的对象。
退货： FieldFormat - 一个FieldFormat提供对字段格式的类型化访问的对象。
getHeadingLevelRange()
public String getHeadingLevelRange()
获取要包含的一系列标题级别。
退货： java.lang.String - 要包含的一系列标题级别。
getHideInWebLayout()
public boolean getHideInWebLayout()
获取是否在 Web 布局视图中隐藏选项卡前导和页码。
退货： boolean - 是否在 Web 布局视图中隐藏选项卡前导和页码。
getIncludeRefDocFields()
public boolean getIncludeRefDocFields()
退货： 布尔值
getIncludeTocEntryFields()
public boolean getIncludeTocEntryFields()
退货： 布尔值
getInsertHyperlinks()
public boolean getInsertHyperlinks()
获取是否使目录条目超链接。
退货： boolean - 是否使目录条目超链接。
getLevelForCustomStyle(Paragraph paragraph, Style style)
public int getLevelForCustomStyle(Paragraph paragraph, Style style)
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| paragraph | Paragraph | |
| style | Style |
退货： 整数
getLocaleId()
public int getLocaleId()
获取字段的 LCID。
退货： int - 字段的 LCID。
getPageNumberOmittingLevelRange()
public String getPageNumberOmittingLevelRange()
获取要从中省略页码的目录条目的级别范围。
退货： java.lang.String - 目录条目的一系列级别，从中省略页码。
getPrefixedSequenceIdentifier()
public String getPrefixedSequenceIdentifier()
获取应为其条目的页码添加前缀的序列的标识符。
退货： java.lang.String - 序列的标识符，应为其添加前缀到条目的页码。
getPreserveLineBreaks()
public boolean getPreserveLineBreaks()
获取是否在表条目中保留换行符。
退货： boolean - 是否在表格条目中保留换行符。
getPreserveTabs()
public boolean getPreserveTabs()
获取是否在表格条目中保留选项卡条目。
退货： boolean - 是否在表条目中保留选项卡条目。
getRangeBookmark()
public Bookmark getRangeBookmark()
退货： Bookmark
getResult()
public String getResult()
获取字段分隔符和字段结尾之间的文本。
退货： java.lang.String - 字段分隔符和字段结尾之间的文本。
getSeparator()
public FieldSeparator getSeparator()
获取表示字段分隔符的节点。可以为空。
退货： FieldSeparator - 表示字段分隔符的节点。
getSequenceSeparator()
public String getSequenceSeparator()
获取用于分隔序号和页码的字符序列。
退货： java.lang.String - 用于分隔序列号和页码的字符序列。
getSkipTables()
public boolean getSkipTables()
退货： 布尔值
getStart()
public FieldStart getStart()
获取表示字段开始的节点。
退货： FieldStart - 表示字段开始的节点。
getSwitchType(String switchName)
public int getSwitchType(String switchName)
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| switchName | java.lang.String |
退货： 整数
getTableOfFiguresLabel()
public String getTableOfFiguresLabel()
获取构建图表时使用的序列标识符的名称。
退货： java.lang.String - 构建图表时使用的序列标识符的名称。
getType()
public int getType()
获取 Microsoft Word 字段类型。
退货： int - Microsoft Word 字段类型。返回值是其中之一FieldType常数。
getUseParagraphOutlineLevel()
public boolean getUseParagraphOutlineLevel()
获取是否使用应用的段落大纲级别。
退货： boolean - 是否使用应用的段落大纲级别。
hashCode()
public native int hashCode()
退货： 整数
isBookmarkRangeSpecified()
public boolean isBookmarkRangeSpecified()
退货： 布尔值
isDirty()
public boolean isDirty()
获取字段的当前结果是否由于对文档进行的其他修改而不再正确（陈旧）。
退货： 布尔值 - 由于对文档进行的其他修改，该字段的当前结果是否不再正确（陈旧）。
isDirty(boolean value)
public void isDirty(boolean value)
设置字段的当前结果是否由于对文档进行的其他修改而不再正确（陈旧）。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 由于对文档进行的其他修改，字段的当前结果是否不再正确（陈旧）。 |
isEntryLevelRangeSpecified()
public boolean isEntryLevelRangeSpecified()
退货： 布尔值
isHeadingLevelRangeSpecified()
public boolean isHeadingLevelRangeSpecified()
退货： 布尔值
isLocked()
public boolean isLocked()
获取字段是否已锁定（不应重新计算其结果）。
退货： boolean - 该字段是否已锁定（不应重新计算其结果）。
isLocked(boolean value)
public void isLocked(boolean value)
设置字段是否被锁定（不应重新计算其结果）。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 该字段是否已锁定（不应重新计算其结果）。 |
isTableOfFigures()
public boolean isTableOfFigures()
退货： 布尔值
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
remove()
public Node remove()
从文档中删除字段。返回字段之后的节点。如果字段的末尾是其父节点的最后一个子节点，则返回其父段落。如果该字段已被删除，则返回null.
退货： Node
setBookmarkName(String value)
public void setBookmarkName(String value)
设置标记用于构建表的文档部分的书签的名称。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 标记用于构建表的文档部分的书签的名称。 |
setCaptionlessTableOfFiguresLabel(String value)
public void setCaptionlessTableOfFiguresLabel(String value)
设置在构建不包括标题标签和编号的图表时使用的序列标识符的名称。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 构建不包括标题标签和编号的图表时使用的序列标识符的名称。 |
setCustomStyles(String value)
public void setCustomStyles(String value)
设置要包含在目录中的除内置标题样式之外的样式列表。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 要包含在目录中的除内置标题样式之外的样式列表。 |
setEntryIdentifier(String value)
public void setEntryIdentifier(String value)
设置一个字符串，该字符串应与包含的 TC 字段的类型标识符匹配。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 应与包含的 TC 字段的类型标识符相匹配的字符串。 |
setEntryLevelRange(String value)
public void setEntryLevelRange(String value)
设置要包含的目录条目的级别范围。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 要包含的目录条目的级别范围。 |
setEntrySeparator(String value)
public void setEntrySeparator(String value)
设置分隔条目及其页码的字符序列。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 分隔条目及其页码的一系列字符。 |
setHeadingLevelRange(String value)
public void setHeadingLevelRange(String value)
设置要包含的标题级别范围。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 要包括的一系列标题级别。 |
setHideInWebLayout(boolean value)
public void setHideInWebLayout(boolean value)
设置是否在 Web 布局视图中隐藏制表符前导符和页码。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否在 Web 布局视图中隐藏制表符前导符和页码。 |
setInsertHyperlinks(boolean value)
public void setInsertHyperlinks(boolean value)
设置是否使目录条目成为超链接。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否制作目录条目超链接。 |
setLocaleId(int value)
public void setLocaleId(int value)
设置字段的 LCID。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | int | 字段的 LCID。 |
setPageNumberOmittingLevelRange(String value)
public void setPageNumberOmittingLevelRange(String value)
设置目录条目的级别范围，从中省略页码。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 目录条目的级别范围，从中省略页码。 |
setPrefixedSequenceIdentifier(String value)
public void setPrefixedSequenceIdentifier(String value)
设置应为其添加前缀到条目页码的序列的标识符。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 应将前缀添加到条目页码的序列标识符。 |
setPreserveLineBreaks(boolean value)
public void setPreserveLineBreaks(boolean value)
设置是否在表条目中保留换行符。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否在表条目中保留换行符。 |
setPreserveTabs(boolean value)
public void setPreserveTabs(boolean value)
设置是否在表格条目中保留选项卡条目。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否在表格条目中保留选项卡条目。 |
setResult(String value)
public void setResult(String value)
设置字段分隔符和字段结尾之间的文本。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 字段分隔符和字段结尾之间的文本。 |
setSequenceSeparator(String value)
public void setSequenceSeparator(String value)
设置用于分隔序号和页码的字符序列。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 用于分隔序号和页码的字符序列。 |
setTableOfFiguresLabel(String value)
public void setTableOfFiguresLabel(String value)
设置构建图表时使用的序列标识符的名称。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 构建图表时使用的序列标识符的名称。 |
setUseParagraphOutlineLevel(boolean value)
public void setUseParagraphOutlineLevel(boolean value)
设置是否使用应用的段落轮廓级别。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否使用应用的段落轮廓级别。 |
toString()
public String toString()
退货： java.lang.字符串
unlink()
public boolean unlink()
执行字段取消链接。
用其最新结果替换该字段。
某些字段，例如 XE（索引条目）字段和 SEQ（序列）字段，无法取消链接。
退货： 布尔值 -{ 如果字段已取消链接，则为真，否则为假。
update()
public void update()
执行字段更新。如果该字段已被更新，则抛出。
update(boolean ignoreMergeFormat)
public void update(boolean ignoreMergeFormat)
执行字段更新。如果该字段已被更新，则抛出。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| ignoreMergeFormat | boolean | 如果为 true，则放弃直接字段结果格式化，无论 MERGEFORMAT 开关如何，否则执行正常更新。 |
updatePageNumbers()
public boolean updatePageNumbers()
更新此目录中项目的页码。
退货： boolean - 如果操作成功则为真。如果删除了任何相关的 TOC 书签，将返回 false。
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| arg0 | long | |
| arg1 | int |
