com.aspose.words

Class FieldSeparator

java.lang.Object

com.aspose.words.Node

com.aspose.words.Inline

com.aspose.words.SpecialChar

com.aspose.words.FieldChar

com.aspose.words.FieldSeparator

All Implemented Interfaces:

java.lang.Cloneable

public class FieldSeparator
extends FieldChar

Represents a Word field separator that separates the field code from the field result.

FieldSeparator is an inline-level node and represented by the ControlChar.FIELD_SEPARATOR_CHAR control character in the document.

FieldSeparator can only be a child of Paragraph.

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 DocumentBuilder.insertField(java.lang.String) method.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
int	getNodeType() Returns NodeType.FIELD_SEPARATOR.

Methods inherited from class com.aspose.words.FieldChar

getField, getFieldType, isDirty, isDirty, isLocked, isLocked

Methods inherited from class com.aspose.words.SpecialChar

getText

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

Overrides:

getNodeType in class SpecialChar

Returns:

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

accept

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

Accepts a visitor.

Calls DocumentVisitor.visitFieldSeparator(com.aspose.words.FieldSeparator).

For more info see the Visitor design pattern.

Overrides:

accept in class SpecialChar

Parameters:

visitor - The visitor that will visit the node.

Returns:

False if the visitor requested the enumeration to stop.

Throws:

java.lang.Exception