FieldRef
遗产： java.lang.Object, com.aspose.words.Field
public class FieldRef extends Field
实现 REF 字段。
要了解更多信息，请访问Working with Fields文档文章。
插入由指定书签表示的文本或图形。
方法
canWorkAsMergeField()
public boolean canWorkAsMergeField()
退货： 布尔值
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
getDisplayResult()
public String getDisplayResult()
获取表示显示的字段结果的文本。这Document.updateListLabels()必须调用方法以获得正确的值FieldListNum, FieldAutoNum, FieldAutoNumOut和FieldAutoNumLgl字段。
退货： java.lang.String - 表示显示字段结果的文本。
getEnd()
public FieldEnd getEnd()
获取表示字段结束的节点。
退货： FieldEnd - 表示字段结束的节点。
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提供对字段格式的类型化访问的对象。
getIncludeNoteOrComment()
public boolean getIncludeNoteOrComment()
获取是否增加书签标记的脚注、尾注和注释编号，并插入相应的脚注、尾注和注释文本。
退货： boolean - 是否增加书签标记的脚注、尾注和注释编号，并插入相应的脚注、尾注和注释文本。
getInsertHyperlink()
public boolean getInsertHyperlink()
获取是否创建到书签段落的超链接。
退货： boolean - 是否创建到书签段落的超链接。
getInsertParagraphNumber()
public boolean getInsertParagraphNumber()
获取是否插入被引用段落的段落编号，与它在文档中出现的完全一样。
退货： boolean - 是否完全按照文档中显示的那样插入引用段落的段落编号。
getInsertParagraphNumberInFullContext()
public boolean getInsertParagraphNumberInFullContext()
获取是否在完整上下文中插入引用段落的段落编号。
退货： boolean - 是否在完整上下文中插入引用段落的段落编号。
getInsertParagraphNumberInRelativeContext()
public boolean getInsertParagraphNumberInRelativeContext()
获取是否在相关上下文中插入引用段落的段落编号。
退货： boolean - 是否在相关上下文中插入引用段落的段落编号。
getInsertRelativePosition()
public boolean getInsertRelativePosition()
获取是否插入引用段落的相对位置。
退货： boolean - 是否插入引用段落的相对位置。
getLocaleId()
public int getLocaleId()
获取字段的 LCID。
退货： int - 字段的 LCID。
getMergeFieldName()
public String getMergeFieldName()
退货： java.lang.字符串
getNumberSeparator()
public String getNumberSeparator()
获取用于分隔序号和页码的字符序列。
退货： java.lang.String - 用于分隔序列号和页码的字符序列。
getResult()
public String getResult()
获取字段分隔符和字段结尾之间的文本。
退货： java.lang.String - 字段分隔符和字段结尾之间的文本。
getSeparator()
public FieldSeparator getSeparator()
获取表示字段分隔符的节点。可以为空。
退货： FieldSeparator - 表示字段分隔符的节点。
getStart()
public FieldStart getStart()
获取表示字段开始的节点。
退货： FieldStart - 表示字段开始的节点。
getSuppressNonDelimiters()
public boolean getSuppressNonDelimiters()
获取是否抑制非定界符。
退货： boolean - 是否抑制非定界符。
getSwitchType(String switchName)
public int getSwitchType(String switchName)
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| switchName | java.lang.String |
退货： 整数
getType()
public int getType()
获取 Microsoft Word 字段类型。
退货： int - Microsoft Word 字段类型。返回值是其中之一FieldType常数。
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 | 该字段是否已锁定（不应重新计算其结果）。 |
isMergeValueRequired()
public boolean isMergeValueRequired()
退货： 布尔值
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 | 引用的书签名称。 |
setIncludeNoteOrComment(boolean value)
public void setIncludeNoteOrComment(boolean value)
设置是否增加书签标记的脚注、尾注和注释编号，并插入相应的脚注、尾注和注释文本。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否增加书签标记的脚注、尾注和注释编号，并插入相应的脚注、尾注和注释文本。 |
setInsertHyperlink(boolean value)
public void setInsertHyperlink(boolean value)
设置是否创建指向已添加书签的段落的超链接。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否创建指向已添加书签的段落的超链接。 |
setInsertParagraphNumber(boolean value)
public void setInsertParagraphNumber(boolean value)
设置是否完全按照文档中显示的那样插入引用段落的段落编号。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否完全按照文档中显示的那样插入引用段落的段落编号。 |
setInsertParagraphNumberInFullContext(boolean value)
public void setInsertParagraphNumberInFullContext(boolean value)
设置是否在完整上下文中插入引用段落的段落编号。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否在完整上下文中插入引用段落的段落编号。 |
setInsertParagraphNumberInRelativeContext(boolean value)
public void setInsertParagraphNumberInRelativeContext(boolean value)
设置是否在相关上下文中插入引用段落的段落编号。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否在相关上下文中插入引用段落的段落编号。 |
setInsertRelativePosition(boolean value)
public void setInsertRelativePosition(boolean value)
设置是否插入引用段落的相对位置。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | boolean | 是否插入引用段落的相对位置。 |
setLocaleId(int value)
public void setLocaleId(int value)
设置字段的 LCID。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | int | 字段的 LCID。 |
setNumberSeparator(String value)
public void setNumberSeparator(String value)
设置用于分隔序号和页码的字符序列。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 用于分隔序号和页码的字符序列。 |
setResult(String value)
public void setResult(String value)
设置字段分隔符和字段结尾之间的文本。
参数：
| 范围 | 类型 | 描述 |
|---|---|---|
| value | java.lang.String | 字段分隔符和字段结尾之间的文本。 |
setSuppressNonDelimiters(boolean value)
public void setSuppressNonDelimiters(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 开关如何，否则执行正常更新。 |
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 |
