ASPOSE home

com.aspose.words
Class FormField

java.lang.Object
  extended by Node
      extended by Inline
          extended by SpecialChar
              extended by com.aspose.words.FormField
All Implemented Interfaces:
java.lang.Iterable, java.lang.Cloneable

public class FormField
extends SpecialChar

Represents a single form field.

Microsoft Word provides the following form fields: checkbox, text input and dropdown (combobox).

FormField is an inline-node and can only be a child of Paragraph.

FormField is represented in a document by a special character and positioned as a character within a line of text.

A complete form field in a Word document is a complex structure represented by several nodes: field start, field code such as FORMTEXT, form field data, field separator, field result, field end and a bookmark. To programmatically create form fields in a Word document use DocumentBuilder.insertCheckBox(java.lang.String, boolean, int), DocumentBuilder.insertTextInput(java.lang.String, int, java.lang.String, java.lang.String, int) and DocumentBuilder.insertComboBox(java.lang.String, java.lang.String[], int) which make sure all of the form field nodes are created in a correct order and in a suitable state.


Property Getters/Setters Summary
booleangetCalculateOnExit()
voidsetCalculateOnExit(boolean value)
           True if references to the specified form field are automatically updated whenever the field is exited.
doublegetCheckBoxSize()
voidsetCheckBoxSize(double value)
           Gets or sets the size of the checkbox in points. Has effect only when IsCheckBoxExactSize is true.
booleangetChecked()
voidsetChecked(boolean value)
           Gets or sets the checked status of the check box form field.
DocumentgetDocument()→ inherited from Node
           Gets the document to which this node belongs.
DropDownItemsgetDropDownItems()
           Provides access to the items of a dropdown form field.
intgetDropDownSelectedIndex()
voidsetDropDownSelectedIndex(int value)
           Gets or sets the index specifying the currently selected item in a dropdown form field.
booleangetEnabled()
voidsetEnabled(boolean value)
           True if a form field is enabled.
java.lang.StringgetEntryMacro()
voidsetEntryMacro(java.lang.String value)
           Returns or sets an entry macro name for the form field.
java.lang.StringgetExitMacro()
voidsetExitMacro(java.lang.String value)
           Returns or sets an exit macro name for the form field.
FontgetFont()→ inherited from Inline
           Provides access to the font formatting of this object.
java.lang.StringgetHelpText()
voidsetHelpText(java.lang.String value)
           Returns or sets the text that's displayed in a message box when the form field has the focus and the user presses F1.
booleanisCheckBoxExactSize()
voidisCheckBoxExactSize(boolean value)
           Gets or sets the boolean value that indicates whether the size of the textbox is automatic or specified explicitly.
booleanisComposite()→ inherited from Node
           Returns true if this node can contain other nodes.
booleanisDeleteRevision()→ inherited from Inline
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisInsertRevision()→ inherited from Inline
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
intgetMaxLength()
voidsetMaxLength(int value)
           Maximum length for the text field. Zero when the length is not limited.
java.lang.StringgetName()
voidsetName(java.lang.String value)
           Gets or sets the form field name.
NodegetNextSibling()→ inherited from Node
           Gets the node immediately following this node.
intgetNodeType()
           Returns NodeType.FormField. The value of the property is NodeType integer constant.
booleangetOwnHelp()
voidsetOwnHelp(boolean value)
           Specifies the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.
booleangetOwnStatus()
voidsetOwnStatus(boolean value)
           Specifies the source of the text that's displayed in the status bar when a form field has the focus.
CompositeNodegetParentNode()→ inherited from Node
           Gets the immediate parent of this node.
ParagraphgetParentParagraph()→ inherited from Inline
           Returns the immediate parent paragraph.
NodegetPreviousSibling()→ inherited from Node
           Gets the node immediately preceding this node.
RangegetRange()→ inherited from Node
           Returns a Range object that represents the portion of a document that is contained in this node.
java.lang.StringgetResult()
voidsetResult(java.lang.String value)
           Gets or sets a string that represents the result of this form field.
java.lang.StringgetStatusText()
voidsetStatusText(java.lang.String value)
           Returns or sets the text that's displayed in the status bar when a form field has the focus.
java.lang.StringgetTextInputFormat()
voidsetTextInputFormat(java.lang.String value)
           Returns or sets the text formatting for a text form field.
intgetTextInputType()
voidsetTextInputType(int value)
           Returns or sets the type of a text form field. The value of the property is TextFormFieldType integer constant.
intgetType()
           Returns the field type. The value of the property is FieldType integer constant.
 
Method Summary
booleanaccept(DocumentVisitor visitor)
           Accepts a visitor.
voidclearRunAttrs()→ inherited from Inline
          Reserved for internal use.
NodedeepClone(boolean isCloneChildren)
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedRunAttr(int fontAttr)→ inherited from Inline
          Reserved for internal use.
NodegetAncestor(java.lang.Class ancestorType)→ inherited from Node
           Gets the first ancestor of the specified type.
java.lang.ObjectgetDirectRunAttr(int fontAttr)→ inherited from Inline
          Reserved for internal use.
DocumentgetDocument()→ inherited from Inline
          Reserved for internal use.
ParagraphgetParentParagraph()→ inherited from Inline
          Reserved for internal use.
Aspose.Words.RunPrgetRunPr()→ inherited from Inline
          Reserved for internal use.
java.lang.StringgetText()→ inherited from SpecialChar
           Gets the special character that this node represents.
java.util.Iteratoriterator()→ inherited from Node
          Provides support for the for each style iteration over child nodes of the node.
NodenextPreOrder(Node rootNode)→ inherited from Node
           Gets next node according to the pre-order tree traversal algorithm.
NodepreviousPreOrder(Node rootNode)→ inherited from Node
           Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()→ inherited from Node
           Removes itself from the parent.
voidsetRunAttr(int fontAttr, java.lang.Object value)→ inherited from Inline
          Reserved for internal use.
voidsetTextInputValue(java.lang.Object newValue)
           Sets the new value in a text form field with text formatting.
java.lang.StringtoTxt()→ inherited from Node
           Exports the content of the node into a string in TXT (plain text) format.
 

Property Getters/Setters Detail

getNodeType

public int getNodeType()
Returns NodeType.FormField. The value of the property is NodeType integer constant.

getName/setName

public java.lang.String getName()

public void setName(java.lang.String value)
Gets or sets the form field name.

getType

public int getType()
Returns the field type. The value of the property is FieldType integer constant.

getResult/setResult

public java.lang.String getResult()

public void setResult(java.lang.String value)
Gets or sets a string that represents the result of this form field.

For a text form field the result is the text that is in the field.

For a checkbox form field the result can be "1" or "0" to indicate checked or unchecked.

For a dropdown form field the result is the string selected in the dropdown.

Note that setting Result for a text form field does not apply formatting specified in TextInputFormat. If you want to set a value and apply the formatting, use the setTextInputValue(java.lang.Object).


getStatusText/setStatusText

public java.lang.String getStatusText()

public void setStatusText(java.lang.String value)
Returns or sets the text that's displayed in the status bar when a form field has the focus.

If the OwnStatus property is set to true, the StatusText property specifies the status bar text. If the OwnStatus property is set to false, the StatusText property specifies the name of an AutoText entry that contains status bar text for the form field.


getOwnStatus/setOwnStatus

public boolean getOwnStatus()

public void setOwnStatus(boolean value)
Specifies the source of the text that's displayed in the status bar when a form field has the focus.

If true, the text specified by the StatusText property is displayed. If false, the text of the AutoText entry specified by the StatusText property is displayed.


getHelpText/setHelpText

public java.lang.String getHelpText()

public void setHelpText(java.lang.String value)
Returns or sets the text that's displayed in a message box when the form field has the focus and the user presses F1.

If the OwnHelp property is set to True, HelpText specifies the text string value. If OwnHelp is set to False, HelpText specifies the name of an AutoText entry that contains help text for the form field.


getOwnHelp/setOwnHelp

public boolean getOwnHelp()

public void setOwnHelp(boolean value)
Specifies the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If True, the text specified by the HelpText property is displayed. If False, the text in the AutoText entry specified by the HelpText property is displayed.


getCalculateOnExit/setCalculateOnExit

public boolean getCalculateOnExit()

public void setCalculateOnExit(boolean value)
True if references to the specified form field are automatically updated whenever the field is exited.

Setting CalculateOnExit only affects the behavior of the form field when the document is opened in Microsoft Word. Aspose.Words never updates references to the form field.


getEntryMacro/setEntryMacro

public java.lang.String getEntryMacro()

public void setEntryMacro(java.lang.String value)
Returns or sets an entry macro name for the form field. The entry macro runs when the form field gets the focus in Microsoft Word.

getExitMacro/setExitMacro

public java.lang.String getExitMacro()

public void setExitMacro(java.lang.String value)
Returns or sets an exit macro name for the form field.

The exit macro runs when the form field loses the focus in Microsoft Word.


getEnabled/setEnabled

public boolean getEnabled()

public void setEnabled(boolean value)
True if a form field is enabled.

If a form field is enabled, its contents can be changed as the form is filled in.


getTextInputFormat/setTextInputFormat

public java.lang.String getTextInputFormat()

public void setTextInputFormat(java.lang.String value)
Returns or sets the text formatting for a text form field.

If the text form field contains regular text, then valid format strings are "", "UPPERCASE", "LOWERCASE", "FIRST CAPITAL" and "TITLE CASE".

If the text form field contains a number or a date/time value, then valid format strings are number or date and time format strings.


getTextInputType/setTextInputType

public int getTextInputType()

public void setTextInputType(int value)
Returns or sets the type of a text form field. The value of the property is TextFormFieldType integer constant.

getMaxLength/setMaxLength

public int getMaxLength()

public void setMaxLength(int value)
Maximum length for the text field. Zero when the length is not limited.

getDropDownItems

public DropDownItems getDropDownItems()
Provides access to the items of a dropdown form field.

Microsoft Word allows maximum 25 items in a dropdown form field.


getDropDownSelectedIndex/setDropDownSelectedIndex

public int getDropDownSelectedIndex()

public void setDropDownSelectedIndex(int value)
Gets or sets the index specifying the currently selected item in a dropdown form field.

getChecked/setChecked

public boolean getChecked()

public void setChecked(boolean value)
Gets or sets the checked status of the check box form field.

Applicable for a check box form field only.


isCheckBoxExactSize/isCheckBoxExactSize

public boolean isCheckBoxExactSize()

public void isCheckBoxExactSize(boolean value)
Gets or sets the boolean value that indicates whether the size of the textbox is automatic or specified explicitly.

Applicable for a check box form field only.

See Also:
CheckBoxSize

getCheckBoxSize/setCheckBoxSize

public double getCheckBoxSize()

public void setCheckBoxSize(double value)
Gets or sets the size of the checkbox in points. Has effect only when IsCheckBoxExactSize is true.

Applicable for a check box form field only.

See Also:
IsCheckBoxExactSize

getParentParagraph

→ inherited from Inline
public Paragraph getParentParagraph()
Returns the immediate parent paragraph. Equivalent to (Paragraph)ParentNode.

getFont

→ inherited from Inline
public Font getFont()
Provides access to the font formatting of this object.

isInsertRevision

→ inherited from Inline
public boolean isInsertRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

isDeleteRevision

→ inherited from Inline
public boolean isDeleteRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

getParentNode

→ inherited from Node
public CompositeNode getParentNode()
Gets the immediate parent of this node.

If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.


getDocument

→ inherited from Node
public Document getDocument()
Gets the document to which this node belongs.

The node always belongs to a document even if it has just been created and not yed added to the tree, or if it has been removed from the tree.


getPreviousSibling

→ inherited from Node
public Node getPreviousSibling()
Gets the node immediately preceding this node.

If there is no preceding node, a null is returned.

Note: Calculating the value of this property iterates from the first child node of ParenNode to this node.

getNextSibling

→ inherited from Node
public Node getNextSibling()
Gets the node immediately following this node. If there is no next node, a null is returned.

isComposite

→ inherited from Node
public boolean isComposite()
Returns true if this node can contain other nodes. This method returns false as Node cannot have child nodes.

getRange

→ inherited from Node
public Range getRange()
Returns a Range object that represents the portion of a document that is contained in this node.

Method Detail

getText

→ inherited from SpecialChar
public java.lang.String getText()
Gets the special character that this node represents.
Returns:
The string that contains the character that this node represents.

accept

public boolean accept(DocumentVisitor visitor)
              throws java.lang.Exception
Accepts a visitor.

Calls DocumentVisitor.VisitFormField.

For more info see the Visitor design pattern.

Parameters:
visitor - The visitor that will visit the node.
Returns:
False if the visitor requested the enumeration to stop.

deepClone

public Node deepClone(boolean isCloneChildren)
              throws java.lang.Exception
Creates a duplicate of the node.

This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.

This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.

Parameters:
isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.
Returns:
The cloned node.

setTextInputValue

public void setTextInputValue(java.lang.Object newValue)
                      throws java.lang.Exception
Sets the new value in a text form field with text formatting.

Applies the text formatting specified in TextInputFormat and stores the value in Result.

Parameters:
newValue - Can be a string, number or a DateTime object.

getAncestor

→ inherited from Node
public Node getAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified type.

The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

Parameters:
ancestorType - The type of the ancestor to retrieve.
Returns:
The ancestor of the specified type or null if no ancestor of this type was found.

remove

→ inherited from Node
public void remove()
           throws java.lang.Exception
Removes itself from the parent.

nextPreOrder

→ inherited from Node
public Node nextPreOrder(Node rootNode)
Gets next node according to the pre-order tree traversal algorithm.
Parameters:
rootNode - The top node (limit) of traversal.
Returns:
Next node in pre-order order. Null if reached the rootNode.

previousPreOrder

→ inherited from Node
public Node previousPreOrder(Node rootNode)
Gets the previous node according to the pre-order tree traversal algorithm.
Parameters:
rootNode - The top node (limit) of traversal.
Returns:
Previous node in pre-order order. Null if reached the rootNode.

toTxt

→ inherited from Node
public java.lang.String toTxt()
            throws java.lang.Exception
Exports the content of the node into a string in TXT (plain text) format.

This method removes field codes and Microsoft Word control characters, uses CrLf combination to mark ends of paragraphs in the resulting string. It produces a different result from getText() which just gets the text from the document without removing field codes or special characters.

Returns:
The content of the node in plain text format.

getDocument

→ inherited from Inline
public Document getDocument()
Reserved for internal use.

getParentParagraph

→ inherited from Inline
public Paragraph getParentParagraph()
Reserved for internal use.

getRunPr

→ inherited from Inline
public Aspose.Words.RunPr getRunPr()
Reserved for internal use.

clearRunAttrs

→ inherited from Inline
public void clearRunAttrs()
Reserved for internal use.

setRunAttr

→ inherited from Inline
public void setRunAttr(int fontAttr, java.lang.Object value)
Reserved for internal use.

fetchInheritedRunAttr

→ inherited from Inline
public java.lang.Object fetchInheritedRunAttr(int fontAttr)
                            throws java.lang.Exception
Reserved for internal use.

getDirectRunAttr

→ inherited from Inline
public java.lang.Object getDirectRunAttr(int fontAttr)
Reserved for internal use.

iterator

→ inherited from Node
public java.util.Iterator iterator()
Provides support for the for each style iteration over child nodes of the node.

Non-CompositeNodes (like Run, SpecialChar and so on) return Empty non-null iterator used internally for XPath traversal.


See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home