com.spire.doc.fields
Class Field

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

All Implemented Interfaces:

IDocumentObject, IDocumentSerializable, IField, IParagraphBase, ITextRange

Direct Known Subclasses:

ControlField, FormField, IfField, MergeField, SequenceField

public class Field
extends TextRange
implements IField

Constructor Summary

Field(IDocument doc)
Creates Field object for specified document

Method Summary

java.lang.String	getCode() Gets or sets the field code.
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
FieldMark	getEnd() Gets or sets the field end.
java.lang.String	getFieldText() Gets or Sets Filed Displays text information.
java.lang.String	getPattern() Returns or sets field pattern.
FieldMark	getSeparator() Gets or sets the field separator.
TextFormat	getTextFormat() Gets or sets regular text format.
FieldType	getType() Returns or sets field type
java.lang.String	getValue() Gets the field value.
boolean	isLocked() Gets the lock property of the filed.if the field is locked,the field can't be updated.
void	isLocked(boolean value) Sets the lock property of the filed.if the field is locked,the field can't be updated.
void	setCode(java.lang.String value) Gets or sets the field code.
void	setEnd(FieldMark value) Gets or sets the field end.
void	setFieldText(java.lang.String value) Gets or Sets Filed Displays text information.
void	setPattern(java.lang.String value) Returns or sets field pattern.
void	setTextFormat(TextFormat value) Gets or sets regular text format.
void	setType(FieldType value) Returns or sets field type
void	update() Update the result of the field.

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

getCharacterFormat, getText, setText

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

applyCharacterFormat, getCharacterFormat, getText, setText

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

Field

public Field(IDocument doc)

Creates Field object for specified document

Method Detail

isLocked

public boolean isLocked()

Gets the lock property of the filed.if the field is locked,the field can't be updated.

Returns:

boolean

isLocked

public void isLocked(boolean value)

Sets the lock property of the filed.if the field is locked,the field can't be updated.

Parameters:

value - boolean

getTextFormat

public TextFormat getTextFormat()

Gets or sets regular text format.

setTextFormat

public void setTextFormat(TextFormat value)

Gets or sets regular text format.

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Overrides:

getDocumentObjectType in class TextRange

Returns:

The type of the document object.

getPattern

public java.lang.String getPattern()

Returns or sets field pattern.

setPattern

public void setPattern(java.lang.String value)

Returns or sets field pattern.

getValue

public java.lang.String getValue()

Gets the field value.

Returns:

The field value.

getType

public FieldType getType()

Returns or sets field type

Specified by:

getType in interface IField

Returns:

setType

public void setType(FieldType value)

Returns or sets field type

Specified by:

setType in interface IField

Parameters:

value - FieldType

getCode

public java.lang.String getCode()

Gets or sets the field code.

Returns:

The field code.

setCode

public void setCode(java.lang.String value)

Gets or sets the field code.

getSeparator

public FieldMark getSeparator()

Gets or sets the field separator.

Returns:

The field separator.

getEnd

public FieldMark getEnd()

Gets or sets the field end.

Returns:

The field mark,Type of FieldEnd.

setEnd

public void setEnd(FieldMark value)

Gets or sets the field end.

getFieldText

public java.lang.String getFieldText()

Gets or Sets Filed Displays text information.

setFieldText

public void setFieldText(java.lang.String value)

Gets or Sets Filed Displays text information.

update

public void update()

Update the result of the field. Can only be simpler field. Direct calls cannot update the NumPages field and Page field, ect.