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:

IRunAttrSource, IDocumentObject, IField, IParagraphBase, ITextRange

Direct Known Subclasses:

CheckBoxFormField, DropDownFormField, TextFormField

public abstract class FormField
extends Field

Constructor Summary

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

Method Summary

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

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

downloadImage, getCode, getDocumentObjectType, 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, getText, setText

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

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

clearRunAttrs, fetchInheritedRunAttr, getDirectRunAttr, getDirectRunAttrByIndex, getDirectRunAttrsCount, setRunAttr

Constructor Detail

FormField

public FormField(IDocument doc)

Initializes a new instance of the FormField class.

Parameters:

doc - doc

FormField

protected FormField(FormField formField,
                    IDocument doc)

Initializes a new instance of the FormField class.

Parameters:

formField - The form field

doc - The doc.

Method Detail

getFormFieldType

public FormFieldType getFormFieldType()

Gets type of this form field.

Returns:

FormFieldType

getName

public java.lang.String getName()

Gets form field title name (bookmark name).

Returns:

The name is unique in the document.

setName

public void setName(java.lang.String value)

Sets form field title name (bookmark name).

Parameters:

value - The name is unique in the document.

getHelp

public java.lang.String getHelp()

Gets form field help.

Returns:

String

setHelp

public void setHelp(java.lang.String value)

Sets form field help.

Parameters:

value - String

getStatusBarHelp

public java.lang.String getStatusBarHelp()

Gets the status bar help.

Returns:

The status bar help.

setStatusBarHelp

public void setStatusBarHelp(java.lang.String value)

Sets the status bar help.

Parameters:

value - The status bar help.

getMacroOnStart

public java.lang.String getMacroOnStart()

Returns the name of macros on start

Returns:

String

setMacroOnStart

public void setMacroOnStart(java.lang.String value)

Sets the name of macros on start

Parameters:

value - String

getMacroOnEnd

public java.lang.String getMacroOnEnd()

Returns the name of macros on end

Returns:

String

setMacroOnEnd

public void setMacroOnEnd(java.lang.String value)

Sets the name of macros on end

Parameters:

value -

getEnabled

public boolean getEnabled()

Get Enabled property (true if form field enabled).

Returns:

boolean

setEnabled

public void setEnabled(boolean value)

Sets Enabled property (true if form field enabled).

Parameters:

value - boolean

getCalculateOnExit

public boolean getCalculateOnExit()

Gets calculate on exit property.

Returns:

boolean

setCalculateOnExit

public void setCalculateOnExit(boolean value)

Sets calculate on exit property.

Parameters:

value - boolean