com.aspose.words.SpecialCharcom.aspose.words.FormField
public class FormField
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
Property Getters/Setters Summary | ||
---|---|---|
boolean | getCalculateOnExit() | |
void | setCalculateOnExit(boolean value) | |
True if references to the specified form field are automatically updated whenever the field is exited. | ||
double | getCheckBoxSize() | |
void | setCheckBoxSize(double value) | |
Gets or sets the size of the checkbox in points. Has effect only when |
||
boolean | getChecked() | |
void | setChecked(boolean value) | |
Gets or sets the checked status of the check box form field. Default value for this property is false. | ||
boolean | getDefault() | |
void | setDefault(boolean value) | |
Gets or sets the default value of the check box form field. Default value for this property is false. | ||
Aspose.Words.DocumentBase | getDocument() | → inherited from Aspose.Words.Node |
Gets the document to which this node belongs. | ||
DropDownItemCollection | getDropDownItems() | |
Provides access to the items of a dropdown form field. | ||
int | getDropDownSelectedIndex() | |
void | setDropDownSelectedIndex(int value) | |
Gets or sets the index specifying the currently selected item in a dropdown form field. | ||
boolean | getEnabled() | |
void | setEnabled(boolean value) | |
True if a form field is enabled. | ||
java.lang.String | getEntryMacro() | |
void | setEntryMacro(java.lang.String value) | |
Returns or sets an entry macro name for the form field. | ||
java.lang.String | getExitMacro() | |
void | setExitMacro(java.lang.String value) | |
Returns or sets an exit macro name for the form field. | ||
Aspose.Words.Font | getFont() | → inherited from Aspose.Words.Inline |
Provides access to the font formatting of this object. | ||
java.lang.String | getHelpText() | |
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. | ||
boolean | isCheckBoxExactSize() | |
void | isCheckBoxExactSize(boolean value) | |
Gets or sets the boolean value that indicates whether the size of the textbox is automatic or specified explicitly. | ||
boolean | isComposite() | → inherited from Aspose.Words.Node |
Returns true if this node can contain other nodes. | ||
boolean | isDeleteRevision() | → inherited from Aspose.Words.Inline |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isFormatRevision() | → inherited from Aspose.Words.Inline |
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled. | ||
boolean | isInsertRevision() | → inherited from Aspose.Words.Inline |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled. | ||
int | getMaxLength() | |
void | setMaxLength(int value) | |
Maximum length for the text field. Zero when the length is not limited. | ||
java.lang.String | getName() | |
void | setName(java.lang.String value) | |
Gets or sets the form field name. | ||
Aspose.Words.Node | getNextSibling() | → inherited from Aspose.Words.Node |
Gets the node immediately following this node. | ||
Aspose.Words.NodeType | getNodeType() | |
Returns NodeType.FormField. | ||
boolean | getOwnHelp() | |
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. | ||
boolean | getOwnStatus() | |
void | setOwnStatus(boolean value) | |
Specifies the source of the text that's displayed in the status bar when a form field has the focus. | ||
Aspose.Words.CompositeNode | getParentNode() | → inherited from Aspose.Words.Node |
Gets the immediate parent of this node. | ||
Aspose.Words.Paragraph | getParentParagraph() | → inherited from Aspose.Words.Inline |
Retrieves the parent |
||
Aspose.Words.Node | getPreviousSibling() | → inherited from Aspose.Words.Node |
Gets the node immediately preceding this node. | ||
Aspose.Words.Range | getRange() | → inherited from Aspose.Words.Node |
Returns a Range object that represents the portion of a document that is contained in this node. | ||
java.lang.String | getResult() | |
void | setResult(java.lang.String value) | |
Gets or sets a string that represents the result of this form field. | ||
java.lang.String | getStatusText() | |
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. | ||
java.lang.String | getTextInputDefault() | |
void | setTextInputDefault(java.lang.String value) | |
Gets or sets the default string or a calculation expression of a text form field. | ||
java.lang.String | getTextInputFormat() | |
void | setTextInputFormat(java.lang.String value) | |
Returns or sets the text formatting for a text form field. | ||
int | getTextInputType() | |
void | setTextInputType(int value) | |
Gets or sets the type of a text form field. The value of the property is TextFormFieldType integer constant. | ||
int | getType() | |
Returns the form field type. The value of the property is FieldType integer constant. |
Method Summary | ||
---|---|---|
void | clearRunAttrs() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
Aspose.Words.Node | deepClone(boolean isCloneChildren) | → inherited from Aspose.Words.Node |
Creates a duplicate of the node. | ||
java.lang.Object | fetchInheritedRunAttr(int fontAttr) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
Aspose.Words.CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Aspose.Words.Node |
Gets the first ancestor of the specified object type. | ||
aspose.obfuscated.type | getDeleteRevision() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
java.lang.Object | getDirectRunAttr(int fontAttr) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
int | getDirectRunAttrsCount() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
Aspose.Words.DocumentBase | getDocument_IInline() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
aspose.obfuscated.type | getExpandedRunPr_IInline(aspose.obfuscated.type flags) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
aspose.obfuscated.type | getInsertRevision() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
Aspose.Words.Paragraph | getParentParagraph_IInline() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
aspose.obfuscated.type | getRunPr_IInline() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
java.lang.String | getText() | → inherited from Aspose.Words.SpecialChar |
Gets the special character that this node represents. | ||
void | remove() | → inherited from Aspose.Words.Node |
Removes itself from the parent. | ||
void | removeField() | |
Removes the complete form field, not just the form field special character. | ||
void | removeRunAttr(int key) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
void | setDeleteRevision(aspose.obfuscated.type value) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
void | setInsertRevision(aspose.obfuscated.type value) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
void | setRunAttr(int fontAttr, java.lang.Object value) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
void | setRunPr_IInline(aspose.obfuscated.type value) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
void | setTextInputValue(java.lang.Object newValue) | |
Applies the text format specified in |
||
java.lang.String | toString(SaveOptions saveOptions) | → inherited from Aspose.Words.Node |
Exports the content of the node into a string using the specified save options. | ||
java.lang.String | toTxt() | → 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) |
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) |
Applicable for a check box form field only.
getChecked/setChecked | |
public boolean getChecked() / public void setChecked(boolean value) |
Applicable for a check box form field only.
getDefault/setDefault | |
public boolean getDefault() / public void setDefault(boolean value) |
Applicable for a check box form field only.
getDocument | → inherited from Aspose.Words.Node |
public Aspose.Words.DocumentBase getDocument() |
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() |
Microsoft Word allows maximum 25 items in a dropdown form field.
getDropDownSelectedIndex/setDropDownSelectedIndex | |
public int getDropDownSelectedIndex() / public void setDropDownSelectedIndex(int value) |
getEnabled/setEnabled | |
public boolean getEnabled() / public void setEnabled(boolean value) |
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) |
getExitMacro/setExitMacro | |
public java.lang.String getExitMacro() / public void setExitMacro(java.lang.String value) |
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() |
getHelpText/setHelpText | |
public java.lang.String getHelpText() / public void setHelpText(java.lang.String value) |
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) |
Applicable for a check box form field only.
isComposite | → inherited from Aspose.Words.Node |
public boolean isComposite() |
isDeleteRevision | → inherited from Aspose.Words.Inline |
public boolean isDeleteRevision() |
isFormatRevision | → inherited from Aspose.Words.Inline |
public boolean isFormatRevision() |
isInsertRevision | → inherited from Aspose.Words.Inline |
public boolean isInsertRevision() |
getMaxLength/setMaxLength | |
public int getMaxLength() / public void setMaxLength(int value) |
getName/setName | |
public java.lang.String getName() / public void setName(java.lang.String value) |
getNextSibling | → inherited from Aspose.Words.Node |
public Aspose.Words.Node getNextSibling() |
getNodeType | |
public Aspose.Words.NodeType getNodeType() |
getOwnHelp/setOwnHelp | |
public boolean getOwnHelp() / public void setOwnHelp(boolean value) |
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) |
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() |
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() |
getPreviousSibling | → inherited from Aspose.Words.Node |
public Aspose.Words.Node getPreviousSibling() |
getRange | → inherited from Aspose.Words.Node |
public Aspose.Words.Range getRange() |
getResult/setResult | |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
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
getStatusText/setStatusText | |
public java.lang.String getStatusText() / public void setStatusText(java.lang.String value) |
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) |
The meaning of this property depends on the value of the
When
When
getTextInputFormat/setTextInputFormat | |
public java.lang.String getTextInputFormat() / public void setTextInputFormat(java.lang.String value) |
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) |
getType | |
public int getType() |
Method Detail |
---|
clearRunAttrs | → inherited from Aspose.Words.Inline |
public void clearRunAttrs() |
deepClone | → inherited from Aspose.Words.Node |
public Aspose.Words.Node deepClone(boolean isCloneChildren) |
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.
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.fetchInheritedRunAttr | → inherited from Aspose.Words.Inline |
public java.lang.Object fetchInheritedRunAttr(int fontAttr) |
getAncestor | → inherited from Aspose.Words.Node |
public Aspose.Words.CompositeNode getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.getDeleteRevision | → inherited from Aspose.Words.Inline |
public aspose.obfuscated.type getDeleteRevision() |
getDirectRunAttr | → inherited from Aspose.Words.Inline |
public java.lang.Object getDirectRunAttr(int fontAttr) |
getDirectRunAttrsCount | → inherited from Aspose.Words.Inline |
public int getDirectRunAttrsCount() |
getDocument_IInline | → inherited from Aspose.Words.Inline |
public Aspose.Words.DocumentBase getDocument_IInline() |
getExpandedRunPr_IInline | → inherited from Aspose.Words.Inline |
public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags) |
getInsertRevision | → inherited from Aspose.Words.Inline |
public aspose.obfuscated.type getInsertRevision() |
getParentParagraph_IInline | → inherited from Aspose.Words.Inline |
public Aspose.Words.Paragraph getParentParagraph_IInline() |
getRunPr_IInline | → inherited from Aspose.Words.Inline |
public aspose.obfuscated.type getRunPr_IInline() |
getText | → inherited from Aspose.Words.SpecialChar |
public java.lang.String getText() |
remove | → inherited from Aspose.Words.Node |
public void remove() |
removeField | |
public void removeField() throws java.lang.Exception |
removeRunAttr | → inherited from Aspose.Words.Inline |
public void removeRunAttr(int key) |
setDeleteRevision | → inherited from Aspose.Words.Inline |
public void setDeleteRevision(aspose.obfuscated.type value) |
setInsertRevision | → inherited from Aspose.Words.Inline |
public void setInsertRevision(aspose.obfuscated.type value) |
setRunAttr | → inherited from Aspose.Words.Inline |
public void setRunAttr(int fontAttr, java.lang.Object value) |
setRunPr_IInline | → inherited from Aspose.Words.Inline |
public void setRunPr_IInline(aspose.obfuscated.type value) |
setTextInputValue | |
public void setTextInputValue(java.lang.Object newValue) throws java.lang.Exception |
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 |
saveOptions
- Specifies the options that control how the node is saved.toTxt | → inherited from Aspose.Words.Node |
public java.lang.String toTxt() throws java.lang.Exception |
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