FieldIndex
遗产： java.lang.Object, com.aspose.words.Field
public class FieldIndex extends Field
实现 INDEX 字段。
要了解更多信息，请访问Working with Fields文档文章。
使用 XE 字段指定的索引条目构建索引，并将该索引插入文档中的此位置。
方法
equals(Object arg0)
public boolean equals(Object arg0)
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| arg0 | java.lang.Object |
退货： 布尔值
getBookmarkName()
public String getBookmarkName()
获取标记文档中用于构建索引的部分的书签名称。
退货： java.lang.String - 标记用于构建索引的文档部分的书签的名称。
getClass()
public final native Class<?> getClass()
退货： java.lang.Class
getCrossReferenceSeparator()
public String getCrossReferenceSeparator()
获取用于分隔交叉引用和其他条目的字符序列。
退货： java.lang.String - 用于分隔交叉引用和其他条目的字符序列。
getDisplayResult()
public String getDisplayResult()
获取表示显示的字段结果的文本。这Document.updateListLabels()必须调用方法以获得正确的值FieldListNum, FieldAutoNum, FieldAutoNumOut和FieldAutoNumLgl字段。
退货： java.lang.String - 表示显示字段结果的文本。
getEnd()
public FieldEnd getEnd()
获取表示字段结束的节点。
退货： FieldEnd - 表示字段结束的节点。
getEntryType()
public String getEntryType()
获取用于构建索引的索引项类型。
退货： java.lang.String - 用于构建索引的索引条目类型。
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提供对字段格式的类型化访问的对象。
getHeading()
public String getHeading()
获取出现在任何给定字母的每组条目开头的标题。
退货： java.lang.String - 出现在任何给定字母的每组条目开头的标题。
getLanguageId()
public String getLanguageId()
获取用于生成索引的语言 ID。
退货： java.lang.String - 用于生成索引的语言 ID。
getLetterRange()
public String getLetterRange()
获取限制索引的字母范围。
退货： java.lang.String - 限制索引的字母范围。
getLocaleId()
public int getLocaleId()
获取字段的 LCID。
退货： int - 字段的 LCID。
getNumberOfColumns()
public String getNumberOfColumns()
获取构建索引时每页使用的列数。
退货： java.lang.String - 构建索引时每页使用的列数。
getPageNumberListSeparator()
public String getPageNumberListSeparator()
获取用于分隔页码列表中两个页码的字符序列。
退货： java.lang.String - 用于分隔页码列表中两个页码的字符序列。
getPageNumberSeparator()
public String getPageNumberSeparator()
获取用于分隔索引条目及其页码的字符序列。
退货： java.lang.String - 用于分隔索引条目及其页码的字符序列。
getPageRangeSeparator()
public String getPageRangeSeparator()
获取用于分隔页面范围的开始和结束的字符序列。
退货： java.lang.String - 用于分隔页面范围的开始和结束的字符序列。
getResult()
public String getResult()
获取字段分隔符和字段结尾之间的文本。
退货： java.lang.String - 字段分隔符和字段结尾之间的文本。
getRunSubentriesOnSameLine()
public boolean getRunSubentriesOnSameLine()
获取是否将子条目运行到与主条目相同的行中。
退货： boolean - 是否将子条目运行到与主条目相同的行中。
getSeparator()
public FieldSeparator getSeparator()
获取表示字段分隔符的节点。可以为空。
退货： FieldSeparator - 表示字段分隔符的节点。
getSequenceName()
public String getSequenceName()
获取其编号包含在页码中的序列的名称。
退货： java.lang.String - 序列的名称，其编号包含在页码中。
getSequenceSeparator()
public String getSequenceSeparator()
获取用于分隔序号和页码的字符序列。
退货： java.lang.String - 用于分隔序列号和页码的字符序列。
getStart()
public FieldStart getStart()
获取表示字段开始的节点。
退货： FieldStart - 表示字段开始的节点。
getSwitchType(String switchName)
public int getSwitchType(String switchName)
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| switchName | java.lang.String |
退货： 整数
getType()
public int getType()
获取 Microsoft Word 字段类型。
退货： int - Microsoft Word 字段类型。返回值是其中之一FieldType常数。
getUseYomi()
public boolean getUseYomi()
获取是否启用对索引条目使用 yomi 文本。
退货： boolean - 是否为索引条目启用 yomi 文本。
hasPageNumberSeparator()
public boolean hasPageNumberSeparator()
获取一个值，该值指示页码分隔符是否被字段的代码覆盖。
退货： boolean - 一个值，指示是否通过字段的代码覆盖页码分隔符。
hasSequenceName()
public boolean hasSequenceName()
获取一个值，该值指示在构建字段的结果时是否应使用序列。
退货： boolean - 一个值，指示在构建字段结果时是否应使用序列。
hashCode()
public native int hashCode()
退货： 整数
isDirty()
public boolean isDirty()
获取字段的当前结果是否由于对文档进行的其他修改而不再正确（陈旧）。
退货： 布尔值 - 由于对文档进行的其他修改，该字段的当前结果是否不再正确（陈旧）。
isDirty(boolean value)
public void isDirty(boolean value)
设置字段的当前结果是否由于对文档进行的其他修改而不再正确（陈旧）。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 由于对文档进行的其他修改，字段的当前结果是否不再正确（陈旧）。 |
isLocked()
public boolean isLocked()
获取字段是否已锁定（不应重新计算其结果）。
退货： boolean - 该字段是否已锁定（不应重新计算其结果）。
isLocked(boolean value)
public void isLocked(boolean value)
设置字段是否被锁定（不应重新计算其结果）。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 该字段是否已锁定（不应重新计算其结果）。 |
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 | 标记用于构建索引的文档部分的书签的名称。 |
setCrossReferenceSeparator(String value)
public void setCrossReferenceSeparator(String value)
设置用于分隔交叉引用和其他条目的字符序列。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 用于分隔交叉引用和其他条目的字符序列。 |
setEntryType(String value)
public void setEntryType(String value)
设置用于构建索引的索引条目类型。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 用于构建索引的索引条目类型。 |
setHeading(String value)
public void setHeading(String value)
为任何给定字母设置一个标题，该标题出现在每组条目的开头。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 出现在任何给定字母的每组条目开头的标题。 |
setLanguageId(String value)
public void setLanguageId(String value)
设置用于生成索引的语言 ID。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 用于生成索引的语言 ID。 |
setLetterRange(String value)
public void setLetterRange(String value)
设置限制索引的字母范围。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 限制索引的字母范围。 |
setLocaleId(int value)
public void setLocaleId(int value)
设置字段的 LCID。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | int | 字段的 LCID。 |
setNumberOfColumns(String value)
public void setNumberOfColumns(String value)
设置构建索引时使用的每页列数。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 构建索引时使用的每页的列数。 |
setPageNumberListSeparator(String value)
public void setPageNumberListSeparator(String value)
设置用于分隔页码列表中两个页码的字符序列。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 用于分隔页码列表中两个页码的字符序列。 |
setPageNumberSeparator(String value)
public void setPageNumberSeparator(String value)
设置用于分隔索引条目及其页码的字符序列。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 用于分隔索引条目及其页码的字符序列。 |
setPageRangeSeparator(String value)
public void setPageRangeSeparator(String value)
设置用于分隔页面范围的开始和结束的字符序列。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 用于分隔页面范围的开始和结束的字符序列。 |
setResult(String value)
public void setResult(String value)
设置字段分隔符和字段结尾之间的文本。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 字段分隔符和字段结尾之间的文本。 |
setRunSubentriesOnSameLine(boolean value)
public void setRunSubentriesOnSameLine(boolean value)
设置是否将子条目运行到与主条目相同的行中。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否将子条目运行到与主条目相同的行中。 |
setSequenceName(String value)
public void setSequenceName(String value)
设置其编号包含在页码中的序列的名称。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 其编号包含在页码中的序列的名称。 |
setSequenceSeparator(String value)
public void setSequenceSeparator(String value)
设置用于分隔序号和页码的字符序列。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 用于分隔序号和页码的字符序列。 |
setUseYomi(boolean value)
public void setUseYomi(boolean value)
设置是否为索引条目启用 yomi 文本。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否为索引条目启用 yomi 文本。 |
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 开关如何，否则执行正常更新。 |
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 |
