ASPOSE home

com.aspose.words
Class SpecialChar

java.lang.Object
  extended by Node
      extended by Inline
          extended by com.aspose.words.SpecialChar
All Implemented Interfaces:
java.lang.Iterable, java.lang.Cloneable
Direct Known Subclasses:
FieldChar, FormField

public class SpecialChar
extends Inline

Base class for special characters in the document.

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 ControlChar.

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
DocumentgetDocument()→ inherited from Node
           Gets the document to which this node belongs.
FontgetFont()→ inherited from Inline
           Provides access to the font formatting of this object.
booleanisComposite()→ inherited from Node
           Returns true if this node can contain other nodes.
booleanisDeleteRevision()→ inherited from Inline
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisInsertRevision()→ inherited from Inline
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
NodegetNextSibling()→ inherited from Node
           Gets the node immediately following this node.
intgetNodeType()
           Returns NodeType.SpecialChar. The value of the property is NodeType integer constant.
CompositeNodegetParentNode()→ inherited from Node
           Gets the immediate parent of this node.
ParagraphgetParentParagraph()→ inherited from Inline
           Returns the immediate parent paragraph.
NodegetPreviousSibling()→ inherited from Node
           Gets the node immediately preceding this node.
RangegetRange()→ inherited from Node
           Returns a Range object that represents the portion of a document that is contained in this node.
 
Method Summary
booleanaccept(DocumentVisitor visitor)
           Accepts a visitor.
voidclearRunAttrs()→ inherited from Inline
          Reserved for internal use.
NodedeepClone(boolean isCloneChildren)→ inherited from Inline
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedRunAttr(int fontAttr)→ inherited from Inline
          Reserved for internal use.
NodegetAncestor(java.lang.Class ancestorType)→ inherited from Node
           Gets the first ancestor of the specified type.
java.lang.ObjectgetDirectRunAttr(int fontAttr)→ inherited from Inline
          Reserved for internal use.
DocumentgetDocument()→ inherited from Inline
          Reserved for internal use.
ParagraphgetParentParagraph()→ inherited from Inline
          Reserved for internal use.
Aspose.Words.RunPrgetRunPr()→ inherited from Inline
          Reserved for internal use.
java.lang.StringgetText()
           Gets the special character that this node represents.
java.util.Iteratoriterator()→ inherited from Node
          Provides support for the for each style iteration over child nodes of the node.
NodenextPreOrder(Node rootNode)→ inherited from Node
           Gets next node according to the pre-order tree traversal algorithm.
NodepreviousPreOrder(Node rootNode)→ inherited from Node
           Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()→ inherited from Node
           Removes itself from the parent.
voidsetRunAttr(int fontAttr, java.lang.Object value)→ inherited from Inline
          Reserved for internal use.
java.lang.StringtoTxt()→ 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()
Returns NodeType.SpecialChar. The value of the property is NodeType integer constant.

getParentParagraph

→ inherited from Inline
public Paragraph getParentParagraph()
Returns the immediate parent paragraph. Equivalent to (Paragraph)ParentNode.

getFont

→ inherited from Inline
public Font getFont()
Provides access to the font formatting of this object.

isInsertRevision

→ inherited from Inline
public boolean isInsertRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

isDeleteRevision

→ inherited from Inline
public boolean isDeleteRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

getParentNode

→ inherited from Node
public CompositeNode getParentNode()
Gets the immediate parent of this node.

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()
Gets the document to which this node belongs.

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()
Gets the node immediately preceding this node.

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()
Gets the node immediately following this node. If there is no next node, a null is returned.

isComposite

→ inherited from Node
public boolean isComposite()
Returns true if this node can contain other nodes. This method returns false as Node cannot have child nodes.

getRange

→ inherited from Node
public Range getRange()
Returns a Range object that represents the portion of a document that is contained in this node.

Method Detail

getText

public java.lang.String getText()
Gets the special character that this node represents.
Returns:
The string that contains the character that this node represents.

accept

public boolean accept(DocumentVisitor visitor)
              throws java.lang.Exception
Accepts a visitor.

Calls DocumentVisitor.VisitSpecialChar.

For more info see the Visitor design pattern.

Parameters:
visitor - The visitor that will visit the node.
Returns:
False if the visitor requested the enumeration to stop.

deepClone

→ inherited from Inline
public Node deepClone(boolean isCloneChildren)
              throws java.lang.Exception
Creates a duplicate of the node.

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.

Parameters:
isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.
Returns:
The cloned node.

getAncestor

→ inherited from Node
public Node getAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified type.

The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

Parameters:
ancestorType - The type of the ancestor to retrieve.
Returns:
The ancestor of the specified type or null if no ancestor of this type was found.

remove

→ inherited from Node
public void remove()
           throws java.lang.Exception
Removes itself from the parent.

nextPreOrder

→ inherited from Node
public Node nextPreOrder(Node rootNode)
Gets next node according to the pre-order tree traversal algorithm.
Parameters:
rootNode - The top node (limit) of traversal.
Returns:
Next node in pre-order order. Null if reached the rootNode.

previousPreOrder

→ inherited from Node
public Node previousPreOrder(Node rootNode)
Gets the previous node according to the pre-order tree traversal algorithm.
Parameters:
rootNode - The top node (limit) of traversal.
Returns:
Previous node in pre-order order. Null if reached the rootNode.

toTxt

→ inherited from Node
public java.lang.String toTxt()
            throws java.lang.Exception
Exports the content of the node into a string in TXT (plain text) format.

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 getText() which just gets the text from the document without removing field codes or special characters.

Returns:
The content of the node in plain text format.

getDocument

→ inherited from Inline
public Document getDocument()
Reserved for internal use.

getParentParagraph

→ inherited from Inline
public Paragraph getParentParagraph()
Reserved for internal use.

getRunPr

→ inherited from Inline
public Aspose.Words.RunPr getRunPr()
Reserved for internal use.

clearRunAttrs

→ inherited from Inline
public void clearRunAttrs()
Reserved for internal use.

setRunAttr

→ inherited from Inline
public void setRunAttr(int fontAttr, java.lang.Object value)
Reserved for internal use.

fetchInheritedRunAttr

→ inherited from Inline
public java.lang.Object fetchInheritedRunAttr(int fontAttr)
                            throws java.lang.Exception
Reserved for internal use.

getDirectRunAttr

→ inherited from Inline
public java.lang.Object getDirectRunAttr(int fontAttr)
Reserved for internal use.

iterator

→ inherited from Node
public java.util.Iterator iterator()
Provides support for the for each style iteration over child nodes of the node.

Non-CompositeNodes (like Run, SpecialChar and so on) return Empty non-null iterator used internally for XPath traversal.


See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home