com.aspose.words
Class FieldEnd

com.aspose.words.SpecialChar
  extended by FieldChar
      extended by com.aspose.words.FieldEnd

public class FieldEnd 
extends FieldChar

Represents an end of a Word field in a document.

FieldEnd is an inline-level node and represented by the #Error Cref: F:Aspose.Words.ControlChar.FieldEndChar control character in the document.

FieldEnd can only be a child of Aspose.Words.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 #Error Cref: M:Aspose.Words.DocumentBuilder.InsertField(System.String) method.


Property Getters/Setters Summary
Aspose.Words.DocumentBasegetDocument()→ inherited from Aspose.Words.Node
           Gets the document to which this node belongs.
intgetFieldType()→ inherited from FieldChar
           Returns the type of the field. The value of the property is FieldType integer constant.
Aspose.Words.FontgetFont()→ inherited from Aspose.Words.Inline
           Provides access to the font formatting of this object.
booleanhasSeparator()
           Returns true if this field has a separator.
booleanisComposite()→ inherited from Aspose.Words.Node
           Returns true if this node can contain other nodes.
booleanisDeleteRevision()→ inherited from Aspose.Words.Inline
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisDirty()→ inherited from FieldChar
voidisDirty(boolean value)
           Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
booleanisFormatRevision()→ inherited from Aspose.Words.Inline
           Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
booleanisInsertRevision()→ inherited from Aspose.Words.Inline
           Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
booleanisLocked()→ inherited from FieldChar
voidisLocked(boolean value)
           Gets or sets whether the parent field is locked (should not recalculate its result).
Aspose.Words.NodegetNextSibling()→ inherited from Aspose.Words.Node
           Gets the node immediately following this node.
Aspose.Words.NodeTypegetNodeType()
           Returns #Error Cref: F:Aspose.Words.NodeType.FieldEnd.
Aspose.Words.CompositeNodegetParentNode()→ inherited from Aspose.Words.Node
           Gets the immediate parent of this node.
Aspose.Words.ParagraphgetParentParagraph()→ inherited from Aspose.Words.Inline
           Retrieves the parent Aspose.Words.Paragraph of this node.
Aspose.Words.NodegetPreviousSibling()→ inherited from Aspose.Words.Node
           Gets the node immediately preceding this node.
Aspose.Words.RangegetRange()→ inherited from Aspose.Words.Node
           Returns a Range object that represents the portion of a document that is contained in this node.
 
Method Summary
voidclearRunAttrs()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voiddd()→ inherited from Aspose.Words.Node
          
Aspose.Words.NodedeepClone(boolean isCloneChildren)→ inherited from Aspose.Words.Node
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedRunAttr(int fontAttr)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
Aspose.Words.CompositeNodegetAncestor(java.lang.Class ancestorType)→ inherited from Aspose.Words.Node
           Gets the first ancestor of the specified object type.
aspose.obfuscated.typegetDeleteRevision()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
java.lang.ObjectgetDirectRunAttr(int fontAttr)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
intgetDirectRunAttrsCount()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
Aspose.Words.DocumentBasegetDocument_IInline()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
aspose.obfuscated.typegetExpandedRunPr_IInline(aspose.obfuscated.type flags)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
FieldgetField()→ inherited from FieldChar
           Returns a field for the field char.
aspose.obfuscated.typegetInsertRevision()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
aspose.obfuscated.typegetMoveFromRevision()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
aspose.obfuscated.typegetMoveToRevision()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
Aspose.Words.ParagraphgetParentParagraph_IInline()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
aspose.obfuscated.typegetRunPr_IInline()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
java.lang.StringgetText()→ inherited from Aspose.Words.SpecialChar
           Gets the special character that this node represents.
voidremove()→ inherited from Aspose.Words.Node
           Removes itself from the parent.
voidremoveRunAttr(int key)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetDeleteRevision(aspose.obfuscated.type value)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetInsertRevision(aspose.obfuscated.type value)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetMoveFromRevision(aspose.obfuscated.type value)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetMoveToRevision(aspose.obfuscated.type value)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetRunAttr(int fontAttr, java.lang.Object value)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetRunPr_IInline(aspose.obfuscated.type value)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
java.lang.StringtoString()→ inherited from Aspose.Words.Node
          
java.lang.StringtoString(SaveOptions saveOptions)→ inherited from Aspose.Words.Node
           Exports the content of the node into a string using the specified save options.
java.lang.StringtoTxt()→ inherited from Aspose.Words.Node
           Exports the content of the node into a string in plain text format.
 

Property Getters/Setters Detail

getDocument

→ inherited from Aspose.Words.Node
public Aspose.Words.DocumentBase 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 yet added to the tree, or if it has been removed from the tree.


getFieldType

→ inherited from FieldChar
public int getFieldType()
Returns the type of the field. The value of the property is FieldType integer constant.

getFont

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

hasSeparator

public boolean hasSeparator()
Returns true if this field has a separator.

isComposite

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

isDeleteRevision

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

isDirty/isDirty

→ inherited from FieldChar
public boolean isDirty() / public void isDirty(boolean value)
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.

isFormatRevision

→ inherited from Aspose.Words.Inline
public boolean isFormatRevision()
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.

isInsertRevision

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

isLocked/isLocked

→ inherited from FieldChar
public boolean isLocked() / public void isLocked(boolean value)
Gets or sets whether the parent field is locked (should not recalculate its result).

getNextSibling

→ inherited from Aspose.Words.Node
public Aspose.Words.Node getNextSibling()
Gets the node immediately following this node. If there is no next node, a null is returned.

getNodeType

public Aspose.Words.NodeType getNodeType()
Returns #Error Cref: F:Aspose.Words.NodeType.FieldEnd.

getParentNode

→ inherited from Aspose.Words.Node
public Aspose.Words.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.


getParentParagraph

→ inherited from Aspose.Words.Inline
public Aspose.Words.Paragraph getParentParagraph()
Retrieves the parent Aspose.Words.Paragraph of this node.

getPreviousSibling

→ inherited from Aspose.Words.Node
public Aspose.Words.Node getPreviousSibling()
Gets the node immediately preceding this node. If there is no preceding node, a null is returned.

getRange

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

Method Detail

clearRunAttrs

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

dd

→ inherited from Aspose.Words.Node
public void dd()

deepClone

→ inherited from Aspose.Words.Node
public Aspose.Words.Node deepClone(boolean isCloneChildren)
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.

fetchInheritedRunAttr

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

getAncestor

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

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

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

getDeleteRevision

→ inherited from Aspose.Words.Inline
public aspose.obfuscated.type getDeleteRevision()
Reserved for internal use.

getDirectRunAttr

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

getDirectRunAttrsCount

→ inherited from Aspose.Words.Inline
public int getDirectRunAttrsCount()
Reserved for internal use.

getDocument_IInline

→ inherited from Aspose.Words.Inline
public Aspose.Words.DocumentBase getDocument_IInline()
Reserved for internal use.

getExpandedRunPr_IInline

→ inherited from Aspose.Words.Inline
public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags)
Reserved for internal use.

getField

→ inherited from FieldChar
public Field getField()
Returns a field for the field char. A new Field object is created each time the method is called.
Returns:
A field for the field char.

getInsertRevision

→ inherited from Aspose.Words.Inline
public aspose.obfuscated.type getInsertRevision()
Reserved for internal use.

getMoveFromRevision

→ inherited from Aspose.Words.Inline
public aspose.obfuscated.type getMoveFromRevision()
Reserved for internal use.

getMoveToRevision

→ inherited from Aspose.Words.Inline
public aspose.obfuscated.type getMoveToRevision()
Reserved for internal use.

getParentParagraph_IInline

→ inherited from Aspose.Words.Inline
public Aspose.Words.Paragraph getParentParagraph_IInline()
Reserved for internal use.

getRunPr_IInline

→ inherited from Aspose.Words.Inline
public aspose.obfuscated.type getRunPr_IInline()
Reserved for internal use.

getText

→ inherited from Aspose.Words.SpecialChar
public java.lang.String getText()
Gets the special character that this node represents.
Returns:
The string that contains the character that this node represents.

remove

→ inherited from Aspose.Words.Node
public void remove()
Removes itself from the parent.

removeRunAttr

→ inherited from Aspose.Words.Inline
public void removeRunAttr(int key)
Reserved for internal use.

setDeleteRevision

→ inherited from Aspose.Words.Inline
public void setDeleteRevision(aspose.obfuscated.type value)
Reserved for internal use.

setInsertRevision

→ inherited from Aspose.Words.Inline
public void setInsertRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveFromRevision

→ inherited from Aspose.Words.Inline
public void setMoveFromRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveToRevision

→ inherited from Aspose.Words.Inline
public void setMoveToRevision(aspose.obfuscated.type value)
Reserved for internal use.

setRunAttr

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

setRunPr_IInline

→ inherited from Aspose.Words.Inline
public void setRunPr_IInline(aspose.obfuscated.type value)
Reserved for internal use.

toString

→ inherited from Aspose.Words.Node
public java.lang.String toString()

toString

→ inherited from Aspose.Words.Node
public java.lang.String toString(SaveOptions saveOptions)
               throws java.lang.Exception
Exports the content of the node into a string using the specified save options.
Parameters:
saveOptions - Specifies the options that control how the node is saved.
Returns:
The content of the node in the specified format.

toTxt

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

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 #Error Cref: M:Aspose.Words.Node.GetText which just gets the text from the node without removing field codes or special characters.

Returns:
The content of the node in plain text format.
See Also:
TxtSaveOptions.ParagraphBreak, TxtSaveOptions.ExportHeadersFooters

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.