com.spire.doc.fields
Class TextFormField

java.lang.Object
  extended by com.spire.doc.OwnerHolder
      extended by com.spire.doc.documents.xml.DocumentSerializable
          extended by com.spire.doc.DocumentObject
              extended by com.spire.doc.DocumentBase
                  extended by com.spire.doc.fields.ParagraphBase
                      extended by com.spire.doc.fields.TextRange
                          extended by com.spire.doc.fields.Field
                              extended by com.spire.doc.fields.FormField
                                  extended by com.spire.doc.fields.TextFormField
All Implemented Interfaces:
IDocumentObject, IDocumentSerializable, IField, IParagraphBase, ITextRange

public class TextFormField
extends FormField


Constructor Summary
TextFormField(IDocument doc)
           Initializes a new instance of the class.
 
Method Summary
 java.lang.String getDefaultText()
          Gets or sets default text for text form field.
 DocumentObjectType getDocumentObjectType()
          Gets the type of the document object.
 int getMaximumLength()
          Gets or sets maximum text length.
 java.lang.String getStringFormat()
          Gets or sets string text format (text, date/time, number) directly.
 java.lang.String getTextEx()
          Returns or setsthe text of text form field.
 TextFormFieldType getTextFieldType()
          Get/sets text form field type.
 TextRange getTextRange()
          Gets or sets form field text range;
 void setDefaultText(java.lang.String value)
          Gets or sets default text for text form field.
 void setMaximumLength(int value)
          Gets or sets maximum text length.
 void setStringFormat(java.lang.String value)
          Gets or sets string text format (text, date/time, number) directly.
 void setText(java.lang.String value)
          Returns or setsthe text of text form field.
 void setTextFieldType(TextFormFieldType value)
          Get/sets text form field type.
 void setTextRange(TextRange value)
          Gets or 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
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, getText
 
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
 
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

TextFormField

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

Parameters:
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/sets text form field type.


setTextFieldType

public void setTextFieldType(TextFormFieldType value)
Get/sets text form field type.


getStringFormat

public java.lang.String getStringFormat()
Gets or sets string text format (text, date/time, number) directly.


setStringFormat

public void setStringFormat(java.lang.String value)
Gets or sets string text format (text, date/time, number) directly.


getDefaultText

public java.lang.String getDefaultText()
Gets or sets default text for text form field.


setDefaultText

public void setDefaultText(java.lang.String value)
Gets or sets default text for text form field.


getMaximumLength

public int getMaximumLength()
Gets or sets maximum text length.


setMaximumLength

public void setMaximumLength(int value)
Gets or sets maximum text length.


getTextRange

public TextRange getTextRange()
Gets or sets form field text range;


setTextRange

public void setTextRange(TextRange value)
Gets or sets form field text range;


getTextEx

public java.lang.String getTextEx()
Returns or setsthe text of text form field.

Overrides:
getTextEx in class Field
Returns:

setText

public void setText(java.lang.String value)
Returns or setsthe text of text form field.

Specified by:
setText in interface ITextRange
Overrides:
setText in class TextRange
Parameters:
value - String