com.spire.doc.fields
Class MergeField

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject
              com.spire.doc.DocumentBase
                  com.spire.doc.fields.ParagraphBase
                      com.spire.doc.fields.TextRange
                          com.spire.doc.fields.Field
                              com.spire.doc.fields.MergeField

All Implemented Interfaces:

IDocumentObject, IDocumentSerializable, IField, IMergeField, IParagraphBase, ITextRange

public class MergeField
extends Field
implements IMergeField

Constructor Summary

MergeField(IDocument doc)
Initializes a new instance of the class.

Method Summary

java.lang.String	getDateFormat() Gets the date format.
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
java.lang.String	getFieldName() Returns or sets field name
java.lang.String	getNumberFormat() Gets the number format.
java.lang.String	getPrefix() Gets the prefix of merge field.
java.lang.String	getText() Returns or sets text.
java.lang.String	getTextAfter() Returns or sets the text after merge field
java.lang.String	getTextBefore() Returns or sets the text before merge field
ParagraphItemCollection	getTextItems() Gets the text items.
void	setFieldName(java.lang.String value) Returns or sets field name
void	setText(java.lang.String value) Returns or sets text.
void	setTextAfter(java.lang.String value) Returns or sets the text after merge field
void	setTextBefore(java.lang.String value) Returns or sets the text before merge field

Methods inherited from class com.spire.doc.fields.Field

getCode, getEnd, getFieldText, getPattern, getSeparator, getTextFormat, getType, getValue, isLocked, isLocked, setCode, setEnd, setFieldText, setPattern, setTextFormat, setType, update

Methods inherited from class com.spire.doc.fields.TextRange

getCharacterFormat

Methods inherited from class com.spire.doc.fields.ParagraphBase

applyCharacterFormat, applyStyle, getChildObjects, getDeleteRevision, getInsertRevision, getNextWidgetSibling, getOwnerParagraph, getPreviousWidgetSibling, getStyleName, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getFirstChild, getLastChild, getNextSibling, getOwner, getPreviousSibling, isComposite, prependChild, toString

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Methods inherited from interface com.spire.doc.interfaces.IField

getType, setType

Methods inherited from interface com.spire.doc.interfaces.ITextRange

applyCharacterFormat, getCharacterFormat

Methods inherited from interface com.spire.doc.interfaces.IParagraphBase

applyStyle, getOwnerParagraph, getStyleName

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

Constructor Detail

MergeField

public MergeField(IDocument doc)

Initializes a new instance of the class.

Parameters:

doc - The document

Method Detail

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Overrides:

getDocumentObjectType in class Field

Returns:

The type of the document object.

getFieldName

public java.lang.String getFieldName()

Returns or sets field name

Specified by:

getFieldName in interface IMergeField

Returns:

The name

setFieldName

public void setFieldName(java.lang.String value)

Returns or sets field name

Specified by:

setFieldName in interface IMergeField

Parameters:

value - The name

getText

public java.lang.String getText()

Description copied from class: TextRange

Returns or sets text.

Specified by:

getText in interface ITextRange

Overrides:

getText in class TextRange

Returns:

String

setText

public void setText(java.lang.String value)

Description copied from class: TextRange

Returns or sets text.

Specified by:

setText in interface ITextRange

Overrides:

setText in class TextRange

Parameters:

value - String

getTextBefore

public java.lang.String getTextBefore()

Returns or sets the text before merge field

Specified by:

getTextBefore in interface IMergeField

Returns:

The text

setTextBefore

public void setTextBefore(java.lang.String value)

Returns or sets the text before merge field

Specified by:

setTextBefore in interface IMergeField

Parameters:

value - The text

getTextAfter

public java.lang.String getTextAfter()

Returns or sets the text after merge field

Specified by:

getTextAfter in interface IMergeField

Returns:

The text

setTextAfter

public void setTextAfter(java.lang.String value)

Returns or sets the text after merge field

Specified by:

setTextAfter in interface IMergeField

Parameters:

value - The text

getPrefix

public java.lang.String getPrefix()

Gets the prefix of merge field.

getNumberFormat

public java.lang.String getNumberFormat()

Gets the number format.

getDateFormat

public java.lang.String getDateFormat()

Gets the date format.

getTextItems

public ParagraphItemCollection getTextItems()

Gets the text items.

Returns:

The text items.