com.aspose.words

Class SpecialChar

java.lang.Object

com.aspose.words.Node

com.aspose.words.Inline

com.aspose.words.SpecialChar

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

AbsolutePositionTab, FieldChar, FormField

public class SpecialChar
extends Inline

Base class for special characters in the document.

To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

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.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
int	getNodeType() Returns NodeType.SpecialChar.
java.lang.String	getText() Gets the special character that this node represents.

Methods inherited from class com.aspose.words.Inline

clearRunAttrs, fetchInheritedRunAttr, getDirectRunAttr, getDocument_IInline, getFont, getParentParagraph_IInline, getParentParagraph, isDeleteRevision, isFormatRevision, isInsertRevision, isMoveFromRevision, isMoveToRevision, removeMoveRevisions, removeRunAttr, setRunAttr

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, isComposite, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getNodeType

public int getNodeType()

Returns NodeType.SpecialChar.

Specified by:

getNodeType in class Node

Returns:

NodeType.SpecialChar. The returned value is one of NodeType constants.

accept

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

Accepts a visitor.

Calls DocumentVisitor.VisitSpecialChar.

For more info see the Visitor design pattern.

Specified by:

accept in class Node

Parameters:

visitor - The visitor that will visit the node.

Returns:

False if the visitor requested the enumeration to stop.

Throws:

java.lang.Exception

getText

public java.lang.String getText()

Gets the special character that this node represents.

Overrides:

getText in class Node

Returns:

The string that contains the character that this node represents.