FieldIncludeText

遗产： java.lang.Object, com.aspose.words.Field

public class FieldIncludeText extends Field

实现 INCLUDETEXT 字段。

要了解更多信息，请访问Working with Fields文档文章。

插入另一个文档中包含的全部或部分文本和图形。

方法

方法	描述
equals(Object arg0)
getBookmarkName()	获取文档中要包含的书签名称。
getClass()
getDisplayResult()	获取表示显示的字段结果的文本。
getEncoding()	获取应用于引用文件中数据的编码。
getEnd()	获取表示字段结束的节点。
getFieldCode()	返回字段开始和字段分隔符之间的文本（如果没有分隔符，则返回字段结束）。
getFieldCode(boolean includeChildFieldCodes)	返回字段开始和字段分隔符之间的文本（如果没有分隔符，则返回字段结束）。
getFormat()	得到一个FieldFormat提供对字段格式的类型化访问的对象。
getLocaleId()	获取字段的 LCID。
getLockFields()	获取是否阻止更新包含文档中的字段。
getMimeType()	获取引用文件的 MIME 类型。
getNamespaceMappings()	获取 XPath 查询的命名空间映射。
getResult()	获取字段分隔符和字段结尾之间的文本。
getSeparator()	获取表示字段分隔符的节点。
getSourceFullName()	使用 IRI 获取文档的位置。
getSourceFullNameArgumentIndex()
getStart()	获取表示字段开始的节点。
getSwitchType(String switchName)
getTextConverter()	获取包含文件格式的文本转换器的名称。
getType()	获取 Microsoft Word 字段类型。
getXPath()	获取 XML 文件所需部分的 XPath。
getXslTransformation()	获取 XSL 转换的位置以格式化 XML 数据。
hashCode()
isDirty()	获取字段的当前结果是否由于对文档进行的其他修改而不再正确（陈旧）。
isDirty(boolean value)	设置字段的当前结果是否由于对文档进行的其他修改而不再正确（陈旧）。
isLocked()	获取字段是否已锁定（不应重新计算其结果）。
isLocked(boolean value)	设置字段是否被锁定（不应重新计算其结果）。
notify()
notifyAll()
remove()	从文档中删除字段。
setBookmarkName(String value)	设置文档中要包含的书签名称。
setEncoding(String value)	设置应用于引用文件中数据的编码。
setLocaleId(int value)	设置字段的 LCID。
setLockFields(boolean value)	设置是否阻止更新包含文档中的字段。
setMimeType(String value)	设置引用文件的 MIME 类型。
setNamespaceMappings(String value)	为 XPath 查询设置命名空间映射。
setResult(String value)	设置字段分隔符和字段结尾之间的文本。
setSourceFullName(String value)	使用 IRI 设置文档的位置。
setTextConverter(String value)	为包含文件的格式设置文本转换器的名称。
setXPath(String value)	为 XML 文件的所需部分设置 XPath。
setXslTransformation(String value)	设置 XSL 转换的位置以格式化 XML 数据。
toString()
unlink()	执行字段取消链接。
update()	执行字段更新。
update(boolean ignoreMergeFormat)	执行字段更新。
wait()
wait(long arg0)
wait(long arg0, int arg1)

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 - 表示显示字段结果的文本。

getEncoding()

public String getEncoding()

获取应用于引用文件中数据的编码。

退货： 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提供对字段格式的类型化访问的对象。

getLocaleId()

public int getLocaleId()

获取字段的 LCID。

退货： int - 字段的 LCID。

getLockFields()

public boolean getLockFields()

获取是否阻止更新包含文档中的字段。

退货： boolean - 是否阻止更新包含文档中的字段。

getMimeType()

public String getMimeType()

获取引用文件的 MIME 类型。

退货： java.lang.String - 引用文件的 MIME 类型。

getNamespaceMappings()

public String getNamespaceMappings()

获取 XPath 查询的命名空间映射。

退货： java.lang.String - XPath 查询的名称空间映射。

getResult()

public String getResult()

获取字段分隔符和字段结尾之间的文本。

退货： java.lang.String - 字段分隔符和字段结尾之间的文本。

getSeparator()

public FieldSeparator getSeparator()

获取表示字段分隔符的节点。可以为空。

退货： FieldSeparator - 表示字段分隔符的节点。

getSourceFullName()

public String getSourceFullName()

使用 IRI 获取文档的位置。

退货： java.lang.String - 使用 IRI 的文档位置。

getSourceFullNameArgumentIndex()

public int getSourceFullNameArgumentIndex()

退货： 整数

getStart()

public FieldStart getStart()

获取表示字段开始的节点。

退货： FieldStart - 表示字段开始的节点。

getSwitchType(String switchName)

public int getSwitchType(String switchName)

参数：

范围	类型	描述
switchName	java.lang.String

退货： 整数

getTextConverter()

public String getTextConverter()

获取包含文件格式的文本转换器的名称。

退货： java.lang.String - 包含文件格式的文本转换器的名称。

getType()

public int getType()

获取 Microsoft Word 字段类型。

退货： int - Microsoft Word 字段类型。返回值是其中之一FieldType常数。

getXPath()

public String getXPath()

获取 XML 文件所需部分的 XPath。

退货： java.lang.String - XML 文件所需部分的 XPath。

getXslTransformation()

public String getXslTransformation()

获取 XSL 转换的位置以格式化 XML 数据。

退货： java.lang.String - 格式化 XML 数据的 XSL 转换位置。

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	要包含在文档中的书签名称。

setEncoding(String value)

public void setEncoding(String value)

设置应用于引用文件中数据的编码。

参数：

范围	类型	描述
value	java.lang.String	应用于引用文件中数据的编码。

setLocaleId(int value)

public void setLocaleId(int value)

设置字段的 LCID。

参数：

范围	类型	描述
value	int	字段的 LCID。

setLockFields(boolean value)

public void setLockFields(boolean value)

设置是否阻止更新包含文档中的字段。

参数：

范围	类型	描述
value	boolean	是否阻止更新包含文档中的字段。

setMimeType(String value)

public void setMimeType(String value)

设置引用文件的 MIME 类型。

参数：

范围	类型	描述
value	java.lang.String	引用文件的 MIME 类型。

setNamespaceMappings(String value)

public void setNamespaceMappings(String value)

为 XPath 查询设置命名空间映射。

参数：

范围	类型	描述
value	java.lang.String	XPath 查询的命名空间映射。

setResult(String value)

public void setResult(String value)

设置字段分隔符和字段结尾之间的文本。

参数：

范围	类型	描述
value	java.lang.String	字段分隔符和字段结尾之间的文本。

setSourceFullName(String value)

public void setSourceFullName(String value)

使用 IRI 设置文档的位置。

参数：

范围	类型	描述
value	java.lang.String	使用 IRI 的文档位置。

setTextConverter(String value)

public void setTextConverter(String value)

为包含文件的格式设置文本转换器的名称。

参数：

范围	类型	描述
value	java.lang.String	包含文件格式的文本转换器的名称。

setXPath(String value)

public void setXPath(String value)

为 XML 文件的所需部分设置 XPath。

参数：

范围	类型	描述
value	java.lang.String	XML 文件所需部分的 XPath。

setXslTransformation(String value)

public void setXslTransformation(String value)

设置 XSL 转换的位置以格式化 XML 数据。

参数：

范围	类型	描述
value	java.lang.String	用于格式化 XML 数据的 XSL 转换的位置。

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