com.spire.doc.fields
Class TextFormField

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.FormField
                                  com.spire.doc.fields.TextFormField

All Implemented Interfaces:

IRunAttrSource, IDocumentObject, IField, IParagraphBase, ITextRange

public class TextFormField
extends FormField

Constructor Summary

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

Method Summary

java.lang.String	getDefaultText() Gets default text for text form field.
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
int	getMaximumLength() Gets maximum text length.
java.lang.String	getStringFormat() Gets string text format (text, date/time, number) directly.
java.lang.String	getText() Returns the text of text form field.
TextFormFieldType	getTextFieldType() Get text form field type.
TextRange	getTextRange() Gets form field text range;
void	setDefaultText(java.lang.String value) Sets default text for text form field.
void	setMaximumLength(int value) Sets maximum text length.
void	setStringFormat(java.lang.String value) Sets string text format (text, date/time, number) directly.
void	setText(java.lang.String value) Sets the text of text form field.
void	setTextFieldType(TextFormFieldType value) Sets text form field type.
void	setTextRange(TextRange value) Sets form field text range;

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

getCalculateOnExit, getEnabled, getFormFieldType, getHelp, getMacroOnEnd, getMacroOnStart, getName, getStatusBarHelp, setCalculateOnExit, setEnabled, setHelp, setMacroOnEnd, setMacroOnStart, setName, setStatusBarHelp

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

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

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

getCharacterFormat

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

applyCharacterFormat, applyStyle, getAncestor, getChildObjects, getOwnerParagraph, getStyleName, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

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

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

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

Methods inherited from interface com.spire.doc.documents.IRunAttrSource

clearRunAttrs, fetchInheritedRunAttr, getDirectRunAttr, getDirectRunAttrByIndex, getDirectRunAttrsCount, setRunAttr

Constructor Detail

TextFormField

public TextFormField(IDocument doc)

Initializes a new instance of the TextFormField class.

Parameters:

doc - doc

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.

getTextFieldType

public TextFormFieldType getTextFieldType()

Get text form field type.

Returns:

The type

setTextFieldType

public void setTextFieldType(TextFormFieldType value)

Sets text form field type.

Parameters:

value - The type

getStringFormat

public java.lang.String getStringFormat()

Gets string text format (text, date/time, number) directly.

Returns:

The string of the text format

setStringFormat

public void setStringFormat(java.lang.String value)

Sets string text format (text, date/time, number) directly.

Parameters:

value - The string of the text format

getDefaultText

public java.lang.String getDefaultText()

Gets default text for text form field.

Returns:

The text

setDefaultText

public void setDefaultText(java.lang.String value)

Sets default text for text form field.

Parameters:

value - The text

getMaximumLength

public int getMaximumLength()

Gets maximum text length.

Returns:

The length

setMaximumLength

public void setMaximumLength(int value)

Sets maximum text length.

Parameters:

value - The length

getTextRange

public TextRange getTextRange()

Gets form field text range;

Returns:

The text range

setTextRange

public void setTextRange(TextRange value)

Sets form field text range;

Parameters:

value - The text range

getText

public java.lang.String getText()

Returns the text of text form field.

Specified by:

getText in interface ITextRange

Overrides:

getText in class TextRange

Returns:

The text

setText

public void setText(java.lang.String value)

Sets the text of text form field.

Specified by:

setText in interface ITextRange

Overrides:

setText in class TextRange

Parameters:

value - The text