java.lang.ObjectNode
Inline
SpecialChar
com.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. | ||
int | getDirectRunAttrsCount() | → inherited from Inline |
IRunAttrSource. | ||
Document | getDocument() | → inherited from 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. | ||
Font | getFont() | → inherited from 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 Node |
Returns true if this node can contain other nodes. | ||
boolean | isDeleteRevision() | → inherited from Inline |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isInsertRevision() | → inherited from Inline |
Returns true if this object was deleted 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. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
int | getNodeType() | |
Returns NodeType.FormField. The value of the property is NodeType integer constant. | ||
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. | ||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Paragraph | getParentParagraph() | → inherited from Inline |
Retrieves the parent |
||
Node | getPreviousSibling() | → inherited from Node |
Gets the node immediately preceding this node. | ||
Range | getRange() | → inherited from 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 | getTextInputFormat() | |
void | setTextInputFormat(java.lang.String value) | |
Returns or sets the text formatting for a text form field. | ||
int | getTextInputType() | |
void | setTextInputType(int value) | |
Returns 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 | ||
---|---|---|
boolean | accept(DocumentVisitor visitor) | |
Accepts a visitor. | ||
void | clearRunAttrs() | → inherited from Inline |
Reserved for internal use. | ||
Node | deepClone(boolean isCloneChildren) | |
Creates a duplicate of the node. | ||
java.lang.Object | fetchInheritedRunAttr(int fontAttr) | → inherited from Inline |
Reserved for internal use. | ||
Node | getAncestor(int ancestorType) | → inherited from Node |
Gets the first ancestor of the specified |
||
Node | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object type. | ||
java.lang.Object | getDirectRunAttr(int fontAttr) | → inherited from Inline |
Reserved for internal use. | ||
void | getDirectRunAttrByIndex(int index, int[] key, java.lang.Object[] value) | → inherited from Inline |
Reserved for internal use. | ||
Document | getDocument() | → inherited from Inline |
Reserved for internal use. | ||
Paragraph | getParentParagraph() | → inherited from Inline |
Reserved for internal use. | ||
Aspose.Words.RunPr | getRunPr() | → inherited from Inline |
Reserved for internal use. | ||
Aspose.Words.RunPr | getSrcRunPr() | → inherited from Inline |
Reserved for internal use. | ||
java.lang.String | getText() | → inherited from SpecialChar |
Gets the special character that this node represents. | ||
java.util.Iterator | iterator() | → inherited from Node |
Provides support for the for each style iteration over child nodes of the node. | ||
Node | nextPreOrder(Node rootNode) | → inherited from Node |
Gets next node according to the pre-order tree traversal algorithm. | ||
Node | previousPreOrder(Node rootNode) | → inherited from Node |
Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | → inherited from Node |
Removes itself from the parent. | ||
void | setRunAttr(int fontAttr, java.lang.Object value) | → inherited from Inline |
Reserved for internal use. | ||
void | setTextInputValue(java.lang.Object newValue) | |
Sets the new value in a text form field with text formatting. | ||
java.lang.String | toTxt() | → inherited from Node |
Exports the content of the node into a string in plain text format. |
Property Getters/Setters Detail |
---|
getNodeType | |
public int getNodeType() |
getName/setName | |
public java.lang.String getName() / public void setName(java.lang.String value) |
getType | |
public int getType() |
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.
Note that setting Result for a text form field does not apply formatting
specified in
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.
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.
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.
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.
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.
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.
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.
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) |
getMaxLength/setMaxLength | |
public int getMaxLength() / public void setMaxLength(int value) |
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) |
getChecked/setChecked | |
public boolean getChecked() / public void setChecked(boolean value) |
Applicable for a check box form field only.
isCheckBoxExactSize/isCheckBoxExactSize | |
public boolean isCheckBoxExactSize() / public void isCheckBoxExactSize(boolean value) |
Applicable for a check box form field only.
getCheckBoxSize/setCheckBoxSize | |
public double getCheckBoxSize() / public void setCheckBoxSize(double value) |
Applicable for a check box form field only.
getParentParagraph | → inherited from Inline |
public Paragraph getParentParagraph() |
getFont | → inherited from Inline |
public Font getFont() |
Example:
Creates a simple document from scratch using the Aspose.Words object model.// Create an "empty" document. Note that like in Microsoft Word, // the empty document has one section, body and one paragraph in it. Document doc = new Document(); // This truly makes the document empty. No sections (not possible in Microsoft Word). doc.removeAllChildren(); // Create a new section node. // Note that the section has not yet been added to the document, // but we have to specify the parent document. Section section = new Section(doc); // Append the section to the document. doc.appendChild(section); // Lets set some properties for the section. section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE); section.getPageSetup().setPaperSize(PaperSize.LETTER); // The section that we created is empty, lets populate it. The section needs at least the Body node. Body body = new Body(doc); section.appendChild(body); // The body needs to have at least one paragraph. // Note that the paragraph has not yet been added to the document, // but we have to specify the parent document. // The parent document is needed so the paragraph can correctly work // with styles and other document-wide information. Paragraph para = new Paragraph(doc); body.appendChild(para); // We can set some formatting for the paragraph para.getParagraphFormat().setStyleName("Heading 1"); para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); // So far we have one empty pararagraph in the document. // The document is valid and can be saved, but lets add some text before saving. // Create a new run of text and add it to our paragraph. Run run = new Run(doc); run.setText("Hello World!"); run.getFont().setColor(Color.RED); para.appendChild(run); // As a matter of interest, you can retrieve text of the whole document and // see that \u000c is automatically appended. \u000c is the end of section character. Assert.assertEquals("Hello World!\u000c", doc.getText()); // Save the document. doc.save(getMyDir() + "Section.CreateFromScratch Out.doc");
isInsertRevision | → inherited from Inline |
public boolean isInsertRevision() |
isDeleteRevision | → inherited from Inline |
public boolean isDeleteRevision() |
getDirectRunAttrsCount | → inherited from Inline |
public int getDirectRunAttrsCount() |
getParentNode | → inherited from Node |
public 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.
Example:
Shows how to access the parent node.// Create a new empty document. It has one section. Document doc = new Document(); // The section is the first child node of the document. Node section = doc.getFirstChild(); // The section's parent node is the document. Assert.assertEquals(doc, section.getParentNode());
Example:
Shows that when you create any node, it requires a document that will own the node.// Open a file from disk. Document doc = new Document(); // Creating a new node of any type requires a document passed into the constructor. Paragraph para = new Paragraph(doc); // The new paragraph node does not yet have a parent. Assert.assertNull(para.getParentNode()); // But the paragraph node knows its document. Assert.assertEquals(doc, para.getDocument()); // The fact that a node always belongs to a document allows us to access and modify // properties that reference the document-wide data such as styles or lists. para.getParagraphFormat().setStyleName("Heading 1"); // Now add the paragaph to the main text of the first section. doc.getFirstSection().getBody().appendChild(para); // The paragraph node is now a child of the Body node. Assert.assertNotNull(para.getParentNode());
getDocument | → inherited from Node |
public Document getDocument() |
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.
Example:
Shows that when you create any node, it requires a document that will own the node.// Open a file from disk. Document doc = new Document(); // Creating a new node of any type requires a document passed into the constructor. Paragraph para = new Paragraph(doc); // The new paragraph node does not yet have a parent. Assert.assertNull(para.getParentNode()); // But the paragraph node knows its document. Assert.assertEquals(doc, para.getDocument()); // The fact that a node always belongs to a document allows us to access and modify // properties that reference the document-wide data such as styles or lists. para.getParagraphFormat().setStyleName("Heading 1"); // Now add the paragaph to the main text of the first section. doc.getFirstSection().getBody().appendChild(para); // The paragraph node is now a child of the Body node. Assert.assertNotNull(para.getParentNode());
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
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.
Example:
Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.// Document is a CompositeNode and LastChild returns the last child node in the Document node. // Since the Document can contain only Section nodes, the last child is the last section. Node lastSection = doc.getLastChild(); // Each node knows its next and previous sibling nodes. // Previous sibling of a section is a section before the specified section. // If the node is the first child, PreviousSibling will return null. Node sectionBeforeLast = lastSection.getPreviousSibling(); if (sectionBeforeLast != null) doc.removeChild(sectionBeforeLast);
getNextSibling | → inherited from Node |
public Node getNextSibling() |
Example:
Shows how to enumerate immediate child nodes of a composite node using NextSibling. In this example we enumerate all paragraphs of a section body.// Get the section that we want to work on. Section section = doc.getSections().get(0); Body body = section.getBody(); // Loop starting from the first child until we reach null. for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling()) { // Output the types of the nodes that we come across. System.out.println(node.getNodeType()); }
Example:
Shows how to efficiently visit all direct and indirect children of a composite node.public void RecurseAllNodes() throws Exception { // Open a document. Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc"); // Invoke the recursive function that will walk the tree. TraverseAllNodes(doc); } /// <summary> /// A simple function that will walk through all children of a specified node recursively /// and print the type of each node to the screen. /// </summary> private void TraverseAllNodes(CompositeNode parentNode) { // This is the most efficient way to loop through immediate children of a node. for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { // Do some useful work. System.out.println(childNode.getNodeType()); // Recurse into the node if it is a composite node. if (childNode.isComposite()) TraverseAllNodes((CompositeNode)childNode); } }
isComposite | → inherited from Node |
public boolean isComposite() |
Example:
Shows how to efficiently visit all direct and indirect children of a composite node.public void RecurseAllNodes() throws Exception { // Open a document. Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc"); // Invoke the recursive function that will walk the tree. TraverseAllNodes(doc); } /// <summary> /// A simple function that will walk through all children of a specified node recursively /// and print the type of each node to the screen. /// </summary> private void TraverseAllNodes(CompositeNode parentNode) { // This is the most efficient way to loop through immediate children of a node. for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { // Do some useful work. System.out.println(childNode.getNodeType()); // Recurse into the node if it is a composite node. if (childNode.isComposite()) TraverseAllNodes((CompositeNode)childNode); } }
getRange | → inherited from Node |
public Range getRange() |
Method Detail |
---|
deepClone | |
public Node deepClone(boolean isCloneChildren) throws java.lang.Exception |
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.accept | |
public boolean accept(DocumentVisitor visitor) throws java.lang.Exception |
Calls DocumentVisitor.VisitFormField.
For more info see the Visitor design pattern.
visitor
- The visitor that will visit the node.setTextInputValue | |
public void setTextInputValue(java.lang.Object newValue) throws java.lang.Exception |
Applies the text formatting specified in
newValue
- Can be a string, number or a DateTime object.getText | → inherited from SpecialChar |
public java.lang.String getText() |
getDirectRunAttr | → inherited from Inline |
public java.lang.Object getDirectRunAttr(int fontAttr) |
getDirectRunAttrByIndex | → inherited from Inline |
public void getDirectRunAttrByIndex(int index, int[] key, java.lang.Object[] value) |
fetchInheritedRunAttr | → inherited from Inline |
public java.lang.Object fetchInheritedRunAttr(int fontAttr) throws java.lang.Exception |
setRunAttr | → inherited from Inline |
public void setRunAttr(int fontAttr, java.lang.Object value) |
clearRunAttrs | → inherited from Inline |
public void clearRunAttrs() |
getAncestor | → inherited from Node |
public Node 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.getAncestor | → inherited from Node |
public Node getAncestor(int ancestorType) |
ancestorType
- A remove | → inherited from Node |
public void remove() throws java.lang.Exception |
Example:
Shows how to remove all nodes of a specific type from a composite node. In this example we remove tables from a section body.// Get the section that we want to work on. Section section = doc.getSections().get(0); Body body = section.getBody(); // Select the first child node in the body. Node curNode = body.getFirstChild(); while (curNode != null) { // Save the pointer to the next sibling node because if the current // node is removed from the parent in the next step, we will have // no way of finding the next node to continue the loop. Node nextNode = curNode.getNextSibling(); // A section body can contain Paragraph and Table nodes. // If the node is a Table, remove it from the parent. if (curNode.getNodeType() == NodeType.TABLE) curNode.remove(); // Continue going through child nodes until null (no more siblings) is reached. curNode = nextNode; }
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.Example:
Shows how to delete all images from a document using pre-order tree traversal.Node curNode = doc; while (curNode != null) { Node nextNode = curNode.nextPreOrder(doc); if (curNode.getNodeType() == NodeType.SHAPE) { Shape shape = (Shape)curNode; // Several shape types can have an image including image shapes and OLE objects. if (shape.canHaveImage()) shape.remove(); } curNode = nextNode; }
previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.toTxt | → inherited from 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
getSrcRunPr | → inherited from Inline |
public Aspose.Words.RunPr getSrcRunPr() |
getRunPr | → inherited from Inline |
public Aspose.Words.RunPr getRunPr() |
getParentParagraph | → inherited from Inline |
public Paragraph getParentParagraph() |
getDocument | → inherited from Inline |
public Document getDocument() |
iterator | → inherited from Node |
public java.util.Iterator iterator() |
Non-CompositeNodes (like Run, SpecialChar and so on) return Empty non-null iterator used internally for XPath traversal.