com.spire.doc.fields
Class FormField

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

All Implemented Interfaces:

IDocumentObject, IDocumentSerializable, IField, IParagraphBase, ITextRange

Direct Known Subclasses:

CheckBoxFormField, DropDownFormField, TextFormField

public abstract class FormField
extends Field

Constructor Summary

protected	FormField(FormField formField, IDocument doc)
	FormField(IDocument doc) Initializes a new instance of the class.

Method Summary

boolean	getCalculateOnExit() Gets or sets calculate on exit property.
boolean	getEnabled() Get/sets Enabled property (true if form field enabled).
FormFieldType	getFormFieldType() Gets type of this form field.
java.lang.String	getHelp() Gets or sets form field help.
java.lang.String	getMacroOnEnd() Returns or setsthe name of macros on end
java.lang.String	getMacroOnStart() Returns or setsthe name of macros on start
java.lang.String	getName() Gets or sets form field title name (bookmark name).
java.lang.String	getStatusBarHelp() Gets or sets the status bar help.
void	setCalculateOnExit(boolean value) Gets or sets calculate on exit property.
void	setEnabled(boolean value) Get/sets Enabled property (true if form field enabled).
void	setHelp(java.lang.String value) Gets or sets form field help.
void	setMacroOnEnd(java.lang.String value) Returns or setsthe name of macros on end
void	setMacroOnStart(java.lang.String value) Returns or setsthe name of macros on start
void	setName(java.lang.String value) Gets or sets form field title name (bookmark name).
void	setStatusBarHelp(java.lang.String value) Gets or sets the status bar help.

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

getCode, getDocumentObjectType, 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, 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

FormField

public FormField(IDocument doc)

Initializes a new instance of the class.

Parameters:

doc -

FormField

protected FormField(FormField formField,
                    IDocument doc)

Method Detail

getFormFieldType

public FormFieldType getFormFieldType()

Gets type of this form field.

getName

public java.lang.String getName()

Gets or sets form field title name (bookmark name). The name is unique in the document.

setName

public void setName(java.lang.String value)

Gets or sets form field title name (bookmark name). The name is unique in the document.

getHelp

public java.lang.String getHelp()

Gets or sets form field help.

setHelp

public void setHelp(java.lang.String value)

Gets or sets form field help.

getStatusBarHelp

public java.lang.String getStatusBarHelp()

Gets or sets the status bar help.

Returns:

The status bar help.

setStatusBarHelp

public void setStatusBarHelp(java.lang.String value)

Gets or sets the status bar help.

getMacroOnStart

public java.lang.String getMacroOnStart()

Returns or setsthe name of macros on start

setMacroOnStart

public void setMacroOnStart(java.lang.String value)

Returns or setsthe name of macros on start

getMacroOnEnd

public java.lang.String getMacroOnEnd()

Returns or setsthe name of macros on end

setMacroOnEnd

public void setMacroOnEnd(java.lang.String value)

Returns or setsthe name of macros on end

getEnabled

public boolean getEnabled()

Get/sets Enabled property (true if form field enabled).

setEnabled

public void setEnabled(boolean value)

Get/sets Enabled property (true if form field enabled).

getCalculateOnExit

public boolean getCalculateOnExit()

Gets or sets calculate on exit property.

setCalculateOnExit

public void setCalculateOnExit(boolean value)

Gets or sets calculate on exit property.