|
ASPOSE home | ||||||||
java.lang.ObjectNode
Inline
SpecialChar
FieldChar
com.aspose.words.FieldSeparator
public class FieldSeparator
A complete field in a Microsoft Word document is a complex structure consisting of
a field start character, field code, field separator character, field result
and field end character. Some fields only have field start, field code and field end. To easily insert a new field into a document, use the
| Property Getters/Setters Summary | ||
|---|---|---|
Document | getDocument() | → inherited from Node |
| Gets the document to which this node belongs. | ||
int | getFieldType() | → inherited from FieldChar |
| Returns the type of the field. The value of the property is FieldType integer constant. | ||
Font | getFont() | → inherited from Inline |
| Provides access to the font formatting of this object. | ||
boolean | isComposite() | → inherited from Node |
| Returns true if this node can contain other nodes. | ||
boolean | isDeleteRevision() | → inherited from Inline |
| Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isInsertRevision() | → inherited from Inline |
| Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
Node | getNextSibling() | → inherited from Node |
| Gets the node immediately following this node. | ||
int | getNodeType() | |
|
Returns |
||
CompositeNode | getParentNode() | → inherited from Node |
| Gets the immediate parent of this node. | ||
Paragraph | getParentParagraph() | → inherited from Inline |
| Returns the immediate parent paragraph. | ||
Node | getPreviousSibling() | → inherited from Node |
| Gets the node immediately preceding this node. | ||
Range | getRange() | → inherited from Node |
| Returns a Range object that represents the portion of a document that is contained in this node. | ||
| Method Summary | ||
|---|---|---|
boolean | accept(DocumentVisitor visitor) | |
| Accepts a visitor. | ||
void | clearRunAttrs() | → inherited from Inline |
| Reserved for internal use. | ||
Node | deepClone(boolean isCloneChildren) | → inherited from Inline |
| Creates a duplicate of the node. | ||
java.lang.Object | fetchInheritedRunAttr(int fontAttr) | → inherited from Inline |
| Reserved for internal use. | ||
Node | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
| Gets the first ancestor of the specified type. | ||
java.lang.Object | getDirectRunAttr(int fontAttr) | → inherited from Inline |
| Reserved for internal use. | ||
Document | getDocument() | → inherited from Inline |
| Reserved for internal use. | ||
Paragraph | getParentParagraph() | → inherited from Inline |
| Reserved for internal use. | ||
Aspose.Words.RunPr | getRunPr() | → inherited from Inline |
| Reserved for internal use. | ||
java.lang.String | getText() | → inherited from SpecialChar |
| Gets the special character that this node represents. | ||
java.util.Iterator | iterator() | → inherited from Node |
| Provides support for the for each style iteration over child nodes of the node. | ||
Node | nextPreOrder(Node rootNode) | → inherited from Node |
| Gets next node according to the pre-order tree traversal algorithm. | ||
Node | previousPreOrder(Node rootNode) | → inherited from Node |
| Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | → inherited from Node |
| Removes itself from the parent. | ||
void | setRunAttr(int fontAttr, java.lang.Object value) | → inherited from Inline |
| Reserved for internal use. | ||
java.lang.String | toTxt() | → inherited from Node |
| Exports the content of the node into a string in TXT (plain text) format. | ||
| Property Getters/Setters Detail |
|---|
getNodeType | |
public int getNodeType() | |
getFieldType | → inherited from FieldChar |
public int getFieldType() | |
getParentParagraph | → inherited from Inline |
public Paragraph getParentParagraph() | |
(Paragraph)ParentNode.getFont | → inherited from Inline |
public Font getFont() | |
isInsertRevision | → inherited from Inline |
public boolean isInsertRevision() | |
isDeleteRevision | → inherited from Inline |
public boolean isDeleteRevision() | |
getParentNode | → inherited from Node |
public CompositeNode getParentNode() | |
If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.
getDocument | → inherited from Node |
public Document getDocument() | |
The node always belongs to a document even if it has just been created and not yed added to the tree, or if it has been removed from the tree.
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() | |
If there is no preceding node, a null is returned.
Note: Calculating the value of this property iterates from the first child node of ParenNode to this node.
getNextSibling | → inherited from Node |
public Node getNextSibling() | |
isComposite | → inherited from Node |
public boolean isComposite() | |
getRange | → inherited from Node |
public Range getRange() | |
| Method Detail |
|---|
getText | → inherited from SpecialChar |
public java.lang.String getText() | |
accept | |
public boolean accept(DocumentVisitor visitor) throws java.lang.Exception | |
Calls
For more info see the Visitor design pattern.
visitor - The visitor that will visit the node.deepClone | → inherited from Inline |
public Node deepClone(boolean isCloneChildren) throws java.lang.Exception | |
This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.
This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.
isCloneChildren - True to recursively clone the subtree under the specified node;
false to clone only the node itself.getAncestor | → inherited from Node |
public Node getAncestor(java.lang.Class ancestorType) | |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType - The type of the ancestor to retrieve.remove | → inherited from Node |
public void remove()
throws java.lang.Exception | |
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) | |
rootNode - The top node (limit) of traversal.previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) | |
rootNode - The top node (limit) of traversal.toTxt | → inherited from Node |
public java.lang.String toTxt()
throws java.lang.Exception | |
This method removes field codes and Microsoft Word control characters, uses CrLf combination
to mark ends of paragraphs in the resulting string. It produces a different result from
getDocument | → inherited from Inline |
public Document getDocument() | |
getParentParagraph | → inherited from Inline |
public Paragraph getParentParagraph() | |
getRunPr | → inherited from Inline |
public Aspose.Words.RunPr getRunPr() | |
clearRunAttrs | → inherited from Inline |
public void clearRunAttrs() | |
setRunAttr | → inherited from Inline |
public void setRunAttr(int fontAttr, java.lang.Object value) | |
fetchInheritedRunAttr | → inherited from Inline |
public java.lang.Object fetchInheritedRunAttr(int fontAttr)
throws java.lang.Exception | |
getDirectRunAttr | → inherited from Inline |
public java.lang.Object getDirectRunAttr(int fontAttr) | |
iterator | → inherited from Node |
public java.util.Iterator iterator() | |
Non-CompositeNodes (like Run, SpecialChar and so on) return Empty non-null iterator used internally for XPath traversal.
|
ASPOSE home | ||||||||