java.lang.ObjectNode
Inline
com.aspose.words.SpecialChar
public class SpecialChar
A Microsoft Word document can include a number of special characters
that represent fields, form fields, shapes, OLE objects, footnotes etc. For the list
of special characters see SpecialChar is an inline-node and can only be a child of Paragraph. SpecialChar char is used as a base class for more specific classes
that represent special characters that Aspose.Words provides programmatic access for.
The SpecialChar class is also used itself to represent special character for which
Aspose.Words does not provide detailed programmatic access.
Property Getters/Setters Summary | ||
---|---|---|
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
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 | isFormatRevision() | → inherited from Inline |
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled. | ||
boolean | isInsertRevision() | → inherited from Inline |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
int | getNodeType() | |
Returns NodeType.SpecialChar. The value of the property is NodeType integer constant. | ||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Paragraph | getParentParagraph() | → inherited from Inline |
Retrieves the parent |
||
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 Node |
Creates a duplicate of the node. | ||
java.lang.Object | fetchInheritedRunAttr(int fontAttr) | → inherited from Inline |
Reserved for internal use. | ||
CompositeNode | getAncestor(int ancestorType) | → inherited from Node |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object type. | ||
aspose.obfuscated.type | getDeleteRevision() | → inherited from Inline |
Reserved for internal use. | ||
java.lang.Object | getDirectRunAttr(int fontAttr) | → inherited from Inline |
Reserved for internal use. | ||
int | getDirectRunAttrsCount() | → inherited from Inline |
Reserved for internal use. | ||
DocumentBase | getDocument_IInline() | → inherited from Inline |
Reserved for internal use. | ||
aspose.obfuscated.type | getExpandedRunPr_IInline(aspose.obfuscated.type flags) | → inherited from Inline |
Reserved for internal use. | ||
aspose.obfuscated.type | getInsertRevision() | → inherited from Inline |
Reserved for internal use. | ||
aspose.obfuscated.type | getMoveFromRevision() | → inherited from Inline |
Reserved for internal use. | ||
aspose.obfuscated.type | getMoveToRevision() | → inherited from Inline |
Reserved for internal use. | ||
Paragraph | getParentParagraph_IInline() | → inherited from Inline |
Reserved for internal use. | ||
aspose.obfuscated.type | getRunPr_IInline() | → inherited from Inline |
Reserved for internal use. | ||
java.lang.String | getText() | |
Gets the special character that this node represents. | ||
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 | removeRunAttr(int key) | → inherited from Inline |
Reserved for internal use. | ||
void | setDeleteRevision(aspose.obfuscated.type value) | → inherited from Inline |
Reserved for internal use. | ||
void | setInsertRevision(aspose.obfuscated.type value) | → inherited from Inline |
Reserved for internal use. | ||
void | setMoveFromRevision(aspose.obfuscated.type value) | → inherited from Inline |
Reserved for internal use. | ||
void | setMoveToRevision(aspose.obfuscated.type value) | → inherited from Inline |
Reserved for internal use. | ||
void | setRunAttr(int fontAttr, java.lang.Object value) | → inherited from Inline |
Reserved for internal use. | ||
void | setRunPr_IInline(aspose.obfuscated.type value) | → inherited from Inline |
Reserved for internal use. | ||
java.lang.String | toString(int saveFormat) | → inherited from Node |
Exports the content of the node into a string in the specified format. | ||
java.lang.String | toTxt() | → inherited from Node |
Exports the content of the node into a string in plain text format. |
Property Getters/Setters Detail |
---|
getDocument | → inherited from Node |
public DocumentBase getDocument() |
The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.
getFont | → inherited from Inline |
public Font getFont() |
isComposite | → inherited from Node |
public boolean isComposite() |
isDeleteRevision | → inherited from Inline |
public boolean isDeleteRevision() |
isFormatRevision | → inherited from Inline |
public boolean isFormatRevision() |
isInsertRevision | → inherited from Inline |
public boolean isInsertRevision() |
getNextSibling | → inherited from Node |
public Node getNextSibling() |
getNodeType | |
public int getNodeType() |
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.
getParentParagraph | → inherited from Inline |
public Paragraph getParentParagraph() |
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
getRange | → inherited from Node |
public Range getRange() |
Method Detail |
---|
accept | |
public boolean accept(DocumentVisitor visitor) throws java.lang.Exception |
Calls DocumentVisitor.VisitSpecialChar.
For more info see the Visitor design pattern.
visitor
- The visitor that will visit the node.clearRunAttrs | → inherited from Inline |
public void clearRunAttrs() |
deepClone | → inherited from Node |
public Node deepClone(boolean isCloneChildren) |
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.fetchInheritedRunAttr | → inherited from Inline |
public java.lang.Object fetchInheritedRunAttr(int fontAttr) |
getAncestor | → inherited from Node |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A getAncestor | → inherited from Node |
public CompositeNode getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.getDeleteRevision | → inherited from Inline |
public aspose.obfuscated.type getDeleteRevision() |
getDirectRunAttr | → inherited from Inline |
public java.lang.Object getDirectRunAttr(int fontAttr) |
getDirectRunAttrsCount | → inherited from Inline |
public int getDirectRunAttrsCount() |
getDocument_IInline | → inherited from Inline |
public DocumentBase getDocument_IInline() |
getExpandedRunPr_IInline | → inherited from Inline |
public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags) |
getInsertRevision | → inherited from Inline |
public aspose.obfuscated.type getInsertRevision() |
getMoveFromRevision | → inherited from Inline |
public aspose.obfuscated.type getMoveFromRevision() |
getMoveToRevision | → inherited from Inline |
public aspose.obfuscated.type getMoveToRevision() |
getParentParagraph_IInline | → inherited from Inline |
public Paragraph getParentParagraph_IInline() |
getRunPr_IInline | → inherited from Inline |
public aspose.obfuscated.type getRunPr_IInline() |
getText | |
public java.lang.String getText() |
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.remove | → inherited from Node |
public void remove() |
removeRunAttr | → inherited from Inline |
public void removeRunAttr(int key) |
setDeleteRevision | → inherited from Inline |
public void setDeleteRevision(aspose.obfuscated.type value) |
setInsertRevision | → inherited from Inline |
public void setInsertRevision(aspose.obfuscated.type value) |
setMoveFromRevision | → inherited from Inline |
public void setMoveFromRevision(aspose.obfuscated.type value) |
setMoveToRevision | → inherited from Inline |
public void setMoveToRevision(aspose.obfuscated.type value) |
setRunAttr | → inherited from Inline |
public void setRunAttr(int fontAttr, java.lang.Object value) |
setRunPr_IInline | → inherited from Inline |
public void setRunPr_IInline(aspose.obfuscated.type value) |
toString | → inherited from Node |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.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
(or any other) combination of characters to mark ends of paragraphs in the resulting string.
It produces a different result from