FieldStart
遗产: java.lang.Object, com.aspose.words.Node, com.aspose.words.Inline, com.aspose.words.SpecialChar, com.aspose.words.FieldChar
public class FieldStart extends FieldChar
表示文档中 Word 字段的开始。
要了解更多信息,请访问Working with Fields文档文章。
FieldStart是一个内联级节点,由ControlChar.FIELD_START_CHAR文档中的控制字符。
FieldStart只能是孩子Paragraph.
Microsoft Word 文档中的完整字段是由字段起始字符、字段代码、字段分隔符、字段结果和字段结束字符组成的复杂结构。有些字段只有字段开始、字段代码和字段结束。
要轻松地将新字段插入文档,请使用DocumentBuilder.insertField(java.lang.String)方法。
方法
accept(DocumentVisitor visitor)
public boolean accept(DocumentVisitor visitor)
接待来访者。
来电DocumentVisitor.visitFieldStart(com.aspose.words.FieldStart).
有关更多信息,请参阅访问者设计模式。
参数:
范围 | 类型 | 描述 |
---|---|---|
visitor | DocumentVisitor | 将访问节点的访问者。 |
退货: 布尔值 -False如果访问者请求枚举停止。
clearRunAttrs()
public void clearRunAttrs()
dd()
public void dd()
deepClone(boolean isCloneChildren)
public Node deepClone(boolean isCloneChildren)
创建节点的副本。
此方法用作节点的复制构造函数。克隆的节点没有父节点,但与原始节点属于同一个文档。
此方法始终执行节点的深层复制。这isCloneChildren参数指定是否也执行复制所有子节点。
参数:
范围 | 类型 | 描述 |
---|---|---|
isCloneChildren | boolean | True 递归克隆指定节点下的子树; false 仅克隆节点本身。 |
退货: Node - 克隆节点。
equals(Object arg0)
public boolean equals(Object arg0)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | java.lang.Object |
退货: 布尔值
fetchInheritedRunAttr(int fontAttr)
public Object fetchInheritedRunAttr(int fontAttr)
参数:
范围 | 类型 | 描述 |
---|---|---|
fontAttr | int |
退货: java.lang.Object
getAncestor(int ancestorType)
public CompositeNode getAncestor(int ancestorType)
参数:
范围 | 类型 | 描述 |
---|---|---|
ancestorType | int |
退货: CompositeNode
getAncestor(Class ancestorType)
public CompositeNode getAncestor(Class ancestorType)
获取指定对象类型的第一个祖先。
参数:
范围 | 类型 | 描述 |
---|---|---|
ancestorType | java.lang.Class | 要检索的祖先的对象类型。 |
退货: CompositeNode - 指定类型的祖先,如果未找到此类型的祖先,则为 null。
如果祖先类型等于 ancestorType 或派生自 ancestorType,则祖先类型匹配。
getClass()
public final native Class<?> getClass()
退货: java.lang.Class
getCustomNodeId()
public int getCustomNodeId()
指定自定义节点标识符。
默认为零。
这个标识符可以任意设置和使用。例如,作为获取外部数据的密钥。
重要说明,指定的值不会保存到输出文件中,并且仅在节点生命周期内存在。
退货: int - 相应的 int 值。
getDirectRunAttr(int fontAttr)
public Object getDirectRunAttr(int fontAttr)
参数:
范围 | 类型 | 描述 |
---|---|---|
fontAttr | int |
退货: java.lang.Object
getDocument()
public DocumentBase getDocument()
获取此节点所属的文档。
该节点始终属于一个文档,即使它刚刚创建并且尚未添加到树中,或者如果它已从树中删除也是如此。
退货: DocumentBase - 该节点所属的文档。
getDocument_IInline()
public DocumentBase getDocument_IInline()
退货: DocumentBase
getField()
public Field getField()
返回字段 char 的字段。一个新的Field每次调用该方法时都会创建对象。
退货: Field - 字段字符的字段。
getFieldData()
public byte[] getFieldData()
获取与字段关联的自定义字段数据。
退货: 字节[] - 与字段关联的自定义字段数据。
getFieldType()
public int getFieldType()
返回字段的类型。
退货: int - 字段的类型。返回值是其中之一FieldType常数。
getFont()
public Font getFont()
提供对此对象的字体格式的访问。
getNextSibling()
public Node getNextSibling()
获取紧跟在该节点之后的节点。如果没有下一个节点,则返回 null。
退货: Node - 紧接此节点之后的节点。
getNodeType()
public int getNodeType()
退货: 整数 -{NodeType.FIELD_START .返回值是其中之一NodeType常数。
getParentNode()
public CompositeNode getParentNode()
获取此节点的直接父级。
如果一个节点刚刚被创建并且还没有被添加到树中,或者如果它已经被从树中移除,则父节点为空。
退货: CompositeNode - 此节点的直接父节点。
getParentParagraph()
public Paragraph getParentParagraph()
检索父级Paragraph这个节点的。
退货: Paragraph - 相应的Paragraph价值。
getParentParagraph_IInline()
public Paragraph getParentParagraph_IInline()
退货: Paragraph
getPreviousSibling()
public Node getPreviousSibling()
获取紧接在该节点之前的节点。如果前面没有节点,则返回 null。
退货: Node - 紧接在该节点之前的节点。
getRange()
public Range getRange()
返回一个Range表示包含在该节点中的文档部分的对象。
退货: Range - 一个Range表示包含在该节点中的文档部分的对象。
getText()
public String getText()
获取此节点表示的特殊字符。
退货: java.lang.String - 包含此节点表示的字符的字符串。
hashCode()
public native int hashCode()
退货: 整数
isComposite()
public boolean isComposite()
如果此节点可以包含其他节点,则返回 true。 (31110,6)
退货: boolean - 如果此节点可以包含其他节点则为真。
isDeleteRevision()
public boolean isDeleteRevision()
如果启用更改跟踪时此对象在 Microsoft Word 中被删除,则返回 true。
退货: 布尔值 - 如果在启用更改跟踪的情况下在 Microsoft Word 中删除了此对象,则为 True。
isDirty()
public boolean isDirty()
获取字段的当前结果是否由于对文档进行的其他修改而不再正确(陈旧)。
退货: 布尔值 - 由于对文档进行的其他修改,该字段的当前结果是否不再正确(陈旧)。
isDirty(boolean value)
public void isDirty(boolean value)
设置字段的当前结果是否由于对文档进行的其他修改而不再正确(陈旧)。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 由于对文档进行的其他修改,字段的当前结果是否不再正确(陈旧)。 |
isFormatRevision()
public boolean isFormatRevision()
如果在启用更改跟踪的情况下在 Microsoft Word 中更改了对象的格式,则返回 true。
退货: 布尔值 - 如果在启用更改跟踪的情况下在 Microsoft Word 中更改了对象的格式,则为 True。
isInsertRevision()
public boolean isInsertRevision()
如果在启用更改跟踪时将此对象插入 Microsoft Word,则返回 true。
退货: 布尔值 - 如果在启用更改跟踪的情况下将此对象插入到 Microsoft Word 中,则为 True。
isLocked()
public boolean isLocked()
获取父字段是否已锁定(不应重新计算其结果)。
退货: boolean - 父字段是否被锁定(不应重新计算其结果)。
isLocked(boolean value)
public void isLocked(boolean value)
设置父字段是否被锁定(不应重新计算其结果)。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 父字段是否被锁定(不应重新计算其结果)。 |
isMoveFromRevision()
public boolean isMoveFromRevision()
退货true如果启用更改跟踪时此对象在 Microsoft Word 中被移动(删除)。
退货: 布尔值 -true如果启用更改跟踪时此对象在 Microsoft Word 中被移动(删除)。
isMoveToRevision()
public boolean isMoveToRevision()
退货true如果启用更改跟踪时在 Microsoft Word 中移动(插入)此对象。
退货: 布尔值 -true如果启用更改跟踪时在 Microsoft Word 中移动(插入)此对象。
nextPreOrder(Node rootNode)
public Node nextPreOrder(Node rootNode)
根据前序树遍历算法获取下一个节点。
参数:
范围 | 类型 | 描述 |
---|---|---|
rootNode | Node | 遍历的顶端节点(极限)。 |
退货: Node - 预定顺序中的下一个节点。如果到达根节点则为空。
nodeTypeToString(int nodeType)
public static String nodeTypeToString(int nodeType)
参数:
范围 | 类型 | 描述 |
---|---|---|
nodeType | int |
退货: java.lang.字符串
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
previousPreOrder(Node rootNode)
public Node previousPreOrder(Node rootNode)
根据前序树遍历算法获取上一个节点。
参数:
范围 | 类型 | 描述 |
---|---|---|
rootNode | Node | 遍历的顶端节点(极限)。 |
退货: Node 预购顺序中的前一个节点。如果到达根节点则为空。
remove()
public void remove()
从父级中移除自身。
removeMoveRevisions()
public void removeMoveRevisions()
removeRunAttr(int key)
public void removeRunAttr(int key)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int |
setCustomNodeId(int value)
public void setCustomNodeId(int value)
指定自定义节点标识符。
默认为零。
这个标识符可以任意设置和使用。例如,作为获取外部数据的密钥。
重要说明,指定的值不会保存到输出文件中,并且仅在节点生命周期内存在。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 对应的int值。 |
setRunAttr(int fontAttr, Object value)
public void setRunAttr(int fontAttr, Object value)
参数:
范围 | 类型 | 描述 |
---|---|---|
fontAttr | int | |
value | java.lang.Object |
toString()
public String toString()
退货: java.lang.字符串
toString(SaveOptions saveOptions)
public String toString(SaveOptions saveOptions)
使用指定的保存选项将节点的内容导出为字符串。
参数:
范围 | 类型 | 描述 |
---|---|---|
saveOptions | SaveOptions | 指定控制节点保存方式的选项。 |
退货: java.lang.String - 指定格式的节点内容。
toString(int saveFormat)
public String toString(int saveFormat)
参数:
范围 | 类型 | 描述 |
---|---|---|
saveFormat | int |
退货: java.lang.字符串
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 |