com.aspose.words
Class FormField

com.aspose.words.SpecialChar
    extended by com.aspose.words.FormField

public class FormField 
extends com.aspose.words.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 #Error Cref: M:Aspose.Words.DocumentBuilder.InsertCheckBox(System.String,System.Boolean,System.Int32), #Error Cref: M:Aspose.Words.DocumentBuilder.InsertTextInput(System.String,Aspose.Words.Fields.TextFormFieldType,System.String,System.String,System.Int32) and #Error Cref: M:Aspose.Words.DocumentBuilder.InsertComboBox(System.String,System.String[],System.Int32) 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. Default value for this property is false.
booleangetDefault()
voidsetDefault(boolean value)
           Gets or sets the default value of the check box form field. Default value for this property is false.
Aspose.Words.DocumentBasegetDocument()→ inherited from Aspose.Words.Node
           Gets the document to which this node belongs.
DropDownItemCollectiongetDropDownItems()
           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.
Aspose.Words.FontgetFont()→ inherited from Aspose.Words.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 Aspose.Words.Node
           Returns true if this node can contain other nodes.
booleanisDeleteRevision()→ inherited from Aspose.Words.Inline
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisFormatRevision()→ inherited from Aspose.Words.Inline
           Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
booleanisInsertRevision()→ inherited from Aspose.Words.Inline
           Returns true if this object was inserted 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.
Aspose.Words.NodegetNextSibling()→ inherited from Aspose.Words.Node
           Gets the node immediately following this node.
Aspose.Words.NodeTypegetNodeType()
           Returns NodeType.FormField.
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.
Aspose.Words.CompositeNodegetParentNode()→ inherited from Aspose.Words.Node
           Gets the immediate parent of this node.
Aspose.Words.ParagraphgetParentParagraph()→ inherited from Aspose.Words.Inline
           Retrieves the parent Aspose.Words.Paragraph of this node.
Aspose.Words.NodegetPreviousSibling()→ inherited from Aspose.Words.Node
           Gets the node immediately preceding this node.
Aspose.Words.RangegetRange()→ inherited from Aspose.Words.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.StringgetTextInputDefault()
voidsetTextInputDefault(java.lang.String value)
           Gets or sets the default string or a calculation expression of a text form field.
java.lang.StringgetTextInputFormat()
voidsetTextInputFormat(java.lang.String value)
           Returns or sets the text formatting for a text form field.
intgetTextInputType()
voidsetTextInputType(int value)
           Gets or sets the type of a text form field. The value of the property is TextFormFieldType integer constant.
intgetType()
           Returns the form field type. The value of the property is FieldType integer constant.
 
Method Summary
voidclearRunAttrs()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
Aspose.Words.NodedeepClone(boolean isCloneChildren)→ inherited from Aspose.Words.Node
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedRunAttr(int fontAttr)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
Aspose.Words.CompositeNodegetAncestor(java.lang.Class ancestorType)→ inherited from Aspose.Words.Node
           Gets the first ancestor of the specified object type.
aspose.obfuscated.typegetDeleteRevision()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
java.lang.ObjectgetDirectRunAttr(int fontAttr)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
intgetDirectRunAttrsCount()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
Aspose.Words.DocumentBasegetDocument_IInline()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
aspose.obfuscated.typegetExpandedRunPr_IInline(aspose.obfuscated.type flags)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
aspose.obfuscated.typegetInsertRevision()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
Aspose.Words.ParagraphgetParentParagraph_IInline()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
aspose.obfuscated.typegetRunPr_IInline()→ inherited from Aspose.Words.Inline
          Reserved for internal use.
java.lang.StringgetText()→ inherited from Aspose.Words.SpecialChar
           Gets the special character that this node represents.
voidremove()→ inherited from Aspose.Words.Node
           Removes itself from the parent.
voidremoveField()
           Removes the complete form field, not just the form field special character.
voidremoveRunAttr(int key)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetDeleteRevision(aspose.obfuscated.type value)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetInsertRevision(aspose.obfuscated.type value)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetRunAttr(int fontAttr, java.lang.Object value)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetRunPr_IInline(aspose.obfuscated.type value)→ inherited from Aspose.Words.Inline
          Reserved for internal use.
voidsetTextInputValue(java.lang.Object newValue)
           Applies the text format specified in TextInputFormat and stores the value in Result.
java.lang.StringtoString(SaveOptions saveOptions)→ inherited from Aspose.Words.Node
           Exports the content of the node into a string using the specified save options.
java.lang.StringtoTxt()→ inherited from Aspose.Words.Node
           Exports the content of the node into a string in plain text format.
 

Property Getters/Setters Detail

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.


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

getChecked/setChecked

public boolean getChecked() / public void setChecked(boolean value)
Gets or sets the checked status of the check box form field. Default value for this property is false.

Applicable for a check box form field only.


getDefault/setDefault

public boolean getDefault() / public void setDefault(boolean value)
Gets or sets the default value of the check box form field. Default value for this property is false.

Applicable for a check box form field only.


getDocument

→ inherited from Aspose.Words.Node
public Aspose.Words.DocumentBase 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 yet added to the tree, or if it has been removed from the tree.


getDropDownItems

public DropDownItemCollection 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.

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.


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.


getFont

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

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.


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

isComposite

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

isDeleteRevision

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

isFormatRevision

→ inherited from Aspose.Words.Inline
public boolean isFormatRevision()
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.

isInsertRevision

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

getMaxLength/setMaxLength

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

getName/setName

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

getNextSibling

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

getNodeType

public Aspose.Words.NodeType getNodeType()
Returns NodeType.FormField.

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.


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.


getParentNode

→ inherited from Aspose.Words.Node
public Aspose.Words.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.


getParentParagraph

→ inherited from Aspose.Words.Inline
public Aspose.Words.Paragraph getParentParagraph()
Retrieves the parent Aspose.Words.Paragraph of this node.

getPreviousSibling

→ inherited from Aspose.Words.Node
public Aspose.Words.Node getPreviousSibling()
Gets the node immediately preceding this node. If there is no preceding node, a null is returned.

getRange

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

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.

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


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.


getTextInputDefault/setTextInputDefault

public java.lang.String getTextInputDefault() / public void setTextInputDefault(java.lang.String value)
Gets or sets the default string or a calculation expression of a text form field.

The meaning of this property depends on the value of the TextInputType property.

When TextInputType is TextFormFieldType.REGULAR or TextFormFieldType.NUMBER, this string specifies the default string for the text form field. This string is the content that Microsoft Word will display in the document when the form field is empty.

When TextInputType is TextFormFieldType.CALCULATED, then this string holds the expression to be calculated. The expression needs to be a formula valid according to Microsoft Word formula field requirements. When you set a new expression using this property, Aspose.Words calculates the formula result automatically and inserts it into the form field.


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". The strings are case-insensitive.

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)
Gets or sets the type of a text form field. The value of the property is TextFormFieldType integer constant.

getType

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

Method Detail

clearRunAttrs

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

deepClone

→ inherited from Aspose.Words.Node
public Aspose.Words.Node deepClone(boolean isCloneChildren)
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.

fetchInheritedRunAttr

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

getAncestor

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

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

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

getDeleteRevision

→ inherited from Aspose.Words.Inline
public aspose.obfuscated.type getDeleteRevision()
Reserved for internal use.

getDirectRunAttr

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

getDirectRunAttrsCount

→ inherited from Aspose.Words.Inline
public int getDirectRunAttrsCount()
Reserved for internal use.

getDocument_IInline

→ inherited from Aspose.Words.Inline
public Aspose.Words.DocumentBase getDocument_IInline()
Reserved for internal use.

getExpandedRunPr_IInline

→ inherited from Aspose.Words.Inline
public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags)
Reserved for internal use.

getInsertRevision

→ inherited from Aspose.Words.Inline
public aspose.obfuscated.type getInsertRevision()
Reserved for internal use.

getParentParagraph_IInline

→ inherited from Aspose.Words.Inline
public Aspose.Words.Paragraph getParentParagraph_IInline()
Reserved for internal use.

getRunPr_IInline

→ inherited from Aspose.Words.Inline
public aspose.obfuscated.type getRunPr_IInline()
Reserved for internal use.

getText

→ inherited from Aspose.Words.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.

remove

→ inherited from Aspose.Words.Node
public void remove()
Removes itself from the parent.

removeField

public void removeField()
                throws java.lang.Exception
Removes the complete form field, not just the form field special character. If there is a bookmark associated with the form field, the bookmark is not removed.

removeRunAttr

→ inherited from Aspose.Words.Inline
public void removeRunAttr(int key)
Reserved for internal use.

setDeleteRevision

→ inherited from Aspose.Words.Inline
public void setDeleteRevision(aspose.obfuscated.type value)
Reserved for internal use.

setInsertRevision

→ inherited from Aspose.Words.Inline
public void setInsertRevision(aspose.obfuscated.type value)
Reserved for internal use.

setRunAttr

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

setRunPr_IInline

→ inherited from Aspose.Words.Inline
public void setRunPr_IInline(aspose.obfuscated.type value)
Reserved for internal use.

setTextInputValue

public void setTextInputValue(java.lang.Object newValue)
                      throws java.lang.Exception
Applies the text format specified in TextInputFormat and stores the value in Result.
Parameters:
newValue - Can be a string, number or a DateTime object.

toString

→ inherited from Aspose.Words.Node
public java.lang.String toString(SaveOptions saveOptions)
               throws java.lang.Exception
Exports the content of the node into a string using the specified save options.
Parameters:
saveOptions - Specifies the options that control how the node is saved.
Returns:
The content of the node in the specified format.

toTxt

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

This method removes field codes and Microsoft Word control characters, uses CrLf (or any other) combination of characters to mark ends of paragraphs in the resulting string. It produces a different result from #Error Cref: M:Aspose.Words.Node.GetText which just gets the text from the node without removing field codes or special characters.

Returns:
The content of the node in plain text format.
See Also:
TxtSaveOptions.ParagraphBreak, TxtSaveOptions.ExportHeadersFooters

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.