FieldTitle
遗产: java.lang.Object, com.aspose.words.Field
public class FieldTitle extends Field
实现 TITLE 字段。
要了解更多信息,请访问Working with Fields文档文章。
检索并可选地设置文档的标题,如记录在Title内置文档属性的属性。
方法
方法 | 描述 |
---|---|
equals(Object arg0) | |
getClass() | |
getDisplayResult() | 获取表示显示的字段结果的文本。 |
getEnd() | 获取表示字段结束的节点。 |
getFieldCode() | 返回字段开始和字段分隔符之间的文本(如果没有分隔符,则返回字段结束)。 |
getFieldCode(boolean includeChildFieldCodes) | 返回字段开始和字段分隔符之间的文本(如果没有分隔符,则返回字段结束)。 |
getFormat() | 得到一个FieldFormat提供对字段格式的类型化访问的对象。 |
getLocaleId() | 获取字段的 LCID。 |
getResult() | 获取字段分隔符和字段结尾之间的文本。 |
getSeparator() | 获取表示字段分隔符的节点。 |
getStart() | 获取表示字段开始的节点。 |
getText() | 获取标题的文本。 |
getType() | 获取 Microsoft Word 字段类型。 |
hashCode() | |
isDirty() | 获取字段的当前结果是否由于对文档进行的其他修改而不再正确(陈旧)。 |
isDirty(boolean value) | 设置字段的当前结果是否由于对文档进行的其他修改而不再正确(陈旧)。 |
isLocked() | 获取字段是否已锁定(不应重新计算其结果)。 |
isLocked(boolean value) | 设置字段是否被锁定(不应重新计算其结果)。 |
notify() | |
notifyAll() | |
remove() | 从文档中删除字段。 |
setLocaleId(int value) | 设置字段的 LCID。 |
setResult(String value) | 设置字段分隔符和字段结尾之间的文本。 |
setText(String value) | 设置标题的文本。 |
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 |
退货: 布尔值
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提供对字段格式的类型化访问的对象。
getLocaleId()
public int getLocaleId()
获取字段的 LCID。
退货: int - 字段的 LCID。
getResult()
public String getResult()
获取字段分隔符和字段结尾之间的文本。
退货: java.lang.String - 字段分隔符和字段结尾之间的文本。
getSeparator()
public FieldSeparator getSeparator()
获取表示字段分隔符的节点。可以为空。
退货: FieldSeparator - 表示字段分隔符的节点。
getStart()
public FieldStart getStart()
获取表示字段开始的节点。
退货: FieldStart - 表示字段开始的节点。
getText()
public String getText()
获取标题的文本。
退货: 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 | 该字段是否已锁定(不应重新计算其结果)。 |
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
remove()
public Node remove()
从文档中删除字段。返回字段之后的节点。如果字段的末尾是其父节点的最后一个子节点,则返回其父段落。如果该字段已被删除,则返回null.
退货: Node
setLocaleId(int value)
public void setLocaleId(int value)
设置字段的 LCID。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 字段的 LCID。 |
setResult(String value)
public void setResult(String value)
设置字段分隔符和字段结尾之间的文本。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | java.lang.String | 字段分隔符和字段结尾之间的文本。 |
setText(String value)
public void setText(String value)
设置标题的文本。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | java.lang.String | 标题的文本。 |
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 |