com.aspose.words

Class FormField

  • All Implemented Interfaces:
    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.

Example:

Shows how to insert a combo box.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.write("Please select a fruit: ");

// Insert a combo box which will allow a user to choose an option from a collection of strings.
FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"Apple", "Banana", "Cherry"}, 0);

Assert.assertEquals("MyComboBox", comboBox.getName());
Assert.assertEquals(FieldType.FIELD_FORM_DROP_DOWN, comboBox.getType());
Assert.assertEquals("Apple", comboBox.getResult());

// The form field will appear in the form of a "select" html tag.
doc.save(getArtifactsDir() + "FormFields.Create.html");

Example:

Shows how to formatting the entire FormField, including the field value.
Document doc = new Document(getMyDir() + "Form fields.docx");

FormField formField = doc.getRange().getFormFields().get(0);
formField.getFont().setBold(true);
formField.getFont().setSize(24.0);
formField.getFont().setColor(Color.RED);

formField.setResult("Aspose.FormField");

doc = DocumentHelper.saveOpen(doc);

Run formFieldRun = doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(1);

Assert.assertEquals("Aspose.FormField", formFieldRun.getText());
Assert.assertEquals(true, formFieldRun.getFont().getBold());
Assert.assertEquals(24.0, formFieldRun.getFont().getSize());
Assert.assertEquals(Color.RED.getRGB(), formFieldRun.getFont().getColor().getRGB());

Property Getters/Setters Summary
booleangetCalculateOnExit()
void
setCalculateOnExit(booleanvalue)
           True if references to the specified form field are automatically updated whenever the field is exited.
doublegetCheckBoxSize()
void
setCheckBoxSize(doublevalue)
           Gets or sets the size of the checkbox in points. Has effect only when IsCheckBoxExactSize is true.
booleangetChecked()
void
setChecked(booleanvalue)
           Gets or sets the checked status of the check box form field. Default value for this property is false.
intgetCustomNodeId()
void
setCustomNodeId(intvalue)
           Specifies custom node identifier.
booleangetDefault()
void
setDefault(booleanvalue)
           Gets or sets the default value of the check box form field. Default value for this property is false.
DocumentBasegetDocument()
Gets the document to which this node belongs.
DropDownItemCollectiongetDropDownItems()
Provides access to the items of a dropdown form field.
intgetDropDownSelectedIndex()
void
           Gets or sets the index specifying the currently selected item in a dropdown form field.
booleangetEnabled()
void
setEnabled(booleanvalue)
           True if a form field is enabled.
java.lang.StringgetEntryMacro()
void
setEntryMacro(java.lang.Stringvalue)
           Returns or sets an entry macro name for the form field.
java.lang.StringgetExitMacro()
void
setExitMacro(java.lang.Stringvalue)
           Returns or sets an exit macro name for the form field.
FontgetFont()
Provides access to the font formatting of this object.
java.lang.StringgetHelpText()
void
setHelpText(java.lang.Stringvalue)
           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()
void
isCheckBoxExactSize(booleanvalue)
           Gets or sets the boolean value that indicates whether the size of the textbox is automatic or specified explicitly.
booleanisComposite()
Returns true if this node can contain other nodes.
booleanisDeleteRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisFormatRevision()
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
booleanisInsertRevision()
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
booleanisMoveFromRevision()
Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
booleanisMoveToRevision()
Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
intgetMaxLength()
void
setMaxLength(intvalue)
           Maximum length for the text field. Zero when the length is not limited.
java.lang.StringgetName()
void
setName(java.lang.Stringvalue)
           Gets or sets the form field name.
NodegetNextSibling()
Gets the node immediately following this node.
intgetNodeType()
Returns NodeType.FormField. The value of the property is NodeType integer constant.
booleangetOwnHelp()
void
setOwnHelp(booleanvalue)
           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()
void
setOwnStatus(booleanvalue)
           Specifies the source of the text that's displayed in the status bar when a form field has the focus.
CompositeNodegetParentNode()
Gets the immediate parent of this node.
ParagraphgetParentParagraph()
Retrieves the parent Paragraph of this node.
NodegetPreviousSibling()
Gets the node immediately preceding this node.
RangegetRange()
Returns a Range object that represents the portion of a document that is contained in this node.
java.lang.StringgetResult()
void
setResult(java.lang.Stringvalue)
           Gets or sets a string that represents the result of this form field.
java.lang.StringgetStatusText()
void
setStatusText(java.lang.Stringvalue)
           Returns or sets the text that's displayed in the status bar when a form field has the focus.
java.lang.StringgetTextInputDefault()
void
setTextInputDefault(java.lang.Stringvalue)
           Gets or sets the default string or a calculation expression of a text form field.
java.lang.StringgetTextInputFormat()
void
setTextInputFormat(java.lang.Stringvalue)
           Returns or sets the text formatting for a text form field.
intgetTextInputType()
void
           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
booleanaccept(DocumentVisitor visitor)
Accepts a visitor.
NodedeepClone(boolean isCloneChildren)
Creates a duplicate of the node.
CompositeNodegetAncestor(int ancestorType)
Gets the first ancestor of the specified NodeType.
CompositeNodegetAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.
java.lang.StringgetText()
Gets the special character that this node represents.
NodenextPreOrder(Node rootNode)
Gets next node according to the pre-order tree traversal algorithm.
NodepreviousPreOrder(Node rootNode)
Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()
Removes itself from the parent.
voidremoveField()
Removes the complete form field, not just the form field special character.
voidsetTextInputValue(java.lang.Object newValue)
Applies the text format specified in TextInputFormat and stores the value in Result.
java.lang.StringtoString(SaveOptions saveOptions)
Exports the content of the node into a string using the specified save options.
java.lang.StringtoString(int saveFormat)
Exports the content of the node into a string in the specified 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
        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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • getCustomNodeId/setCustomNodeId

        public int getCustomNodeId() / public void setCustomNodeId(int value)
        
        Specifies custom node identifier.

        Default is zero.

        This identifier can be set and used arbitrarily. For example, as a key to get external data.

      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • getDocument

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

        Example:

        Shows how to create a node and set its owning document.
        Document doc = new Document();
        Paragraph para = new Paragraph(doc);
        para.appendChild(new Run(doc, "Hello world!"));
        
        // We have not yet appended this paragraph as a child to any composite node.
        Assert.assertNull(para.getParentNode());
        
        // If a node is an appropriate child node type of another composite node,
        // we can attach it as a child only if both nodes have the same owner document.
        // The owner document is the document we passed to the node's constructor.
        // We have not attached this paragraph to the document, so the document does not contain its text.
        Assert.assertEquals(para.getDocument(), doc);
        Assert.assertEquals("", doc.getText().trim());
        
        // Since the document owns this paragraph, we can apply one of its styles to the paragraph's contents.
        para.getParagraphFormat().setStyleName("Heading 1");
        
        // Add this node to the document, and then verify its contents.
        doc.getFirstSection().getBody().appendChild(para);
        
        Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
        Assert.assertEquals("Hello world!", doc.getText().trim());
      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • 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.

        Microsoft Word allows strings with at most 32 characters.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • 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.

        Microsoft Word allows strings with at most 32 characters.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • getFont

        public Font getFont()
        
        Provides access to the font formatting of this object.

        Example:

        Shows how to construct an Aspose.Words document by hand.
        Document doc = new Document();
        
        // A blank document contains one section, one body and one paragraph.
        // Call the "RemoveAllChildren" method to remove all those nodes,
        // and end up with a document node with no children.
        doc.removeAllChildren();
        
        // This document now has no composite child nodes that we can add content to.
        // If we wish to edit it, we will need to repopulate its node collection.
        // First, create a new section, and then append it as a child to the root document node.
        Section section = new Section(doc);
        doc.appendChild(section);
        
        // Set some page setup properties for the section.
        section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
        section.getPageSetup().setPaperSize(PaperSize.LETTER);
        
        // A section needs a body, which will contain and display all its contents
        // on the page between the section's header and footer.
        Body body = new Body(doc);
        section.appendChild(body);
        
        // Create a paragraph, set some formatting properties, and then append it as a child to the body.
        Paragraph para = new Paragraph(doc);
        
        para.getParagraphFormat().setStyleName("Heading 1");
        para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        
        body.appendChild(para);
        
        // Finally, add some content to do the document. Create a run,
        // set its appearance and contents, and then append it as a child to the paragraph.
        Run run = new Run(doc);
        run.setText("Hello World!");
        run.getFont().setColor(Color.RED);
        para.appendChild(run);
        
        Assert.assertEquals("Hello World!", doc.getText().trim());
        
        doc.save(getArtifactsDir() + "Section.CreateManually.docx");
      • 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.

        Microsoft Word allows strings with at most 255 characters.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
        See Also:
        CheckBoxSize
      • isComposite

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

        Example:

        Shows how to traverse a composite node's tree of child nodes.
        public void recurseChildren() throws Exception {
            Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
            // Any node that can contain child nodes, such as the document itself, is composite.
            Assert.assertTrue(doc.isComposite());
        
            // Invoke the recursive function that will go through and print all the child nodes of a composite node.
            traverseAllNodes(doc, 0);
        }
        
        /// <summary>
        /// Recursively traverses a node tree while printing the type of each node
        /// with an indent depending on depth as well as the contents of all inline nodes.
        /// </summary>
        @Test(enabled = false)
        public void traverseAllNodes(CompositeNode parentNode, int depth) {
            for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
                System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));
        
                // Recurse into the node if it is a composite node. Otherwise, print its contents if it is an inline node.
                if (childNode.isComposite()) {
                    System.out.println();
                    traverseAllNodes((CompositeNode) childNode, depth + 1);
                } else if (childNode instanceof Inline) {
                    System.out.println(" - \"{childNode.GetText().Trim()}\"");
                } else {
                    System.out.println();
                }
            }
        }
      • isDeleteRevision

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

        Example:

        Shows how to determine the revision type of an inline node.
        Document doc = new Document(getMyDir() + "Revision runs.docx");
        
        // When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
        // is turned on in Microsoft Word, the changes we apply count as revisions.
        // When editing a document using Aspose.Words, we can begin tracking revisions by
        // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method.
        // We can either accept revisions to assimilate them into the document
        // or reject them to change the proposed change effectively.
        Assert.assertEquals(6, doc.getRevisions().getCount());
        
        // The parent node of a revision is the run that the revision concerns. A Run is an Inline node.
        Run run = (Run) doc.getRevisions().get(0).getParentNode();
        
        Paragraph firstParagraph = run.getParentParagraph();
        RunCollection runs = firstParagraph.getRuns();
        
        Assert.assertEquals(runs.getCount(), 6);
        
        // Below are five types of revisions that can flag an Inline node.
        // 1 -  An "insert" revision:
        // This revision occurs when we insert text while tracking changes.
        Assert.assertTrue(runs.get(2).isInsertRevision());
        
        // 2 -  A "format" revision:
        // This revision occurs when we change the formatting of text while tracking changes.
        Assert.assertTrue(runs.get(2).isFormatRevision());
        
        // 3 -  A "move from" revision:
        // When we highlight text in Microsoft Word, and then drag it to a different place in the document
        // while tracking changes, two revisions appear.
        // The "move from" revision is a copy of the text originally before we moved it.
        Assert.assertTrue(runs.get(4).isMoveFromRevision());
        
        // 4 -  A "move to" revision:
        // The "move to" revision is the text that we moved in its new position in the document.
        // "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
        // Accepting a move revision deletes the "move from" revision and its text,
        // and keeps the text from the "move to" revision.
        // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
        Assert.assertTrue(runs.get(1).isMoveToRevision());
        
        // 5 -  A "delete" revision:
        // This revision occurs when we delete text while tracking changes. When we delete text like this,
        // it will stay in the document as a revision until we either accept the revision,
        // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
        Assert.assertTrue(runs.get(5).isDeleteRevision());
      • isFormatRevision

        public boolean isFormatRevision()
        
        Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.

        Example:

        Shows how to determine the revision type of an inline node.
        Document doc = new Document(getMyDir() + "Revision runs.docx");
        
        // When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
        // is turned on in Microsoft Word, the changes we apply count as revisions.
        // When editing a document using Aspose.Words, we can begin tracking revisions by
        // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method.
        // We can either accept revisions to assimilate them into the document
        // or reject them to change the proposed change effectively.
        Assert.assertEquals(6, doc.getRevisions().getCount());
        
        // The parent node of a revision is the run that the revision concerns. A Run is an Inline node.
        Run run = (Run) doc.getRevisions().get(0).getParentNode();
        
        Paragraph firstParagraph = run.getParentParagraph();
        RunCollection runs = firstParagraph.getRuns();
        
        Assert.assertEquals(runs.getCount(), 6);
        
        // Below are five types of revisions that can flag an Inline node.
        // 1 -  An "insert" revision:
        // This revision occurs when we insert text while tracking changes.
        Assert.assertTrue(runs.get(2).isInsertRevision());
        
        // 2 -  A "format" revision:
        // This revision occurs when we change the formatting of text while tracking changes.
        Assert.assertTrue(runs.get(2).isFormatRevision());
        
        // 3 -  A "move from" revision:
        // When we highlight text in Microsoft Word, and then drag it to a different place in the document
        // while tracking changes, two revisions appear.
        // The "move from" revision is a copy of the text originally before we moved it.
        Assert.assertTrue(runs.get(4).isMoveFromRevision());
        
        // 4 -  A "move to" revision:
        // The "move to" revision is the text that we moved in its new position in the document.
        // "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
        // Accepting a move revision deletes the "move from" revision and its text,
        // and keeps the text from the "move to" revision.
        // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
        Assert.assertTrue(runs.get(1).isMoveToRevision());
        
        // 5 -  A "delete" revision:
        // This revision occurs when we delete text while tracking changes. When we delete text like this,
        // it will stay in the document as a revision until we either accept the revision,
        // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
        Assert.assertTrue(runs.get(5).isDeleteRevision());
      • isInsertRevision

        public boolean isInsertRevision()
        
        Returns true if this object was inserted in Microsoft Word while change tracking was enabled.

        Example:

        Shows how to determine the revision type of an inline node.
        Document doc = new Document(getMyDir() + "Revision runs.docx");
        
        // When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
        // is turned on in Microsoft Word, the changes we apply count as revisions.
        // When editing a document using Aspose.Words, we can begin tracking revisions by
        // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method.
        // We can either accept revisions to assimilate them into the document
        // or reject them to change the proposed change effectively.
        Assert.assertEquals(6, doc.getRevisions().getCount());
        
        // The parent node of a revision is the run that the revision concerns. A Run is an Inline node.
        Run run = (Run) doc.getRevisions().get(0).getParentNode();
        
        Paragraph firstParagraph = run.getParentParagraph();
        RunCollection runs = firstParagraph.getRuns();
        
        Assert.assertEquals(runs.getCount(), 6);
        
        // Below are five types of revisions that can flag an Inline node.
        // 1 -  An "insert" revision:
        // This revision occurs when we insert text while tracking changes.
        Assert.assertTrue(runs.get(2).isInsertRevision());
        
        // 2 -  A "format" revision:
        // This revision occurs when we change the formatting of text while tracking changes.
        Assert.assertTrue(runs.get(2).isFormatRevision());
        
        // 3 -  A "move from" revision:
        // When we highlight text in Microsoft Word, and then drag it to a different place in the document
        // while tracking changes, two revisions appear.
        // The "move from" revision is a copy of the text originally before we moved it.
        Assert.assertTrue(runs.get(4).isMoveFromRevision());
        
        // 4 -  A "move to" revision:
        // The "move to" revision is the text that we moved in its new position in the document.
        // "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
        // Accepting a move revision deletes the "move from" revision and its text,
        // and keeps the text from the "move to" revision.
        // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
        Assert.assertTrue(runs.get(1).isMoveToRevision());
        
        // 5 -  A "delete" revision:
        // This revision occurs when we delete text while tracking changes. When we delete text like this,
        // it will stay in the document as a revision until we either accept the revision,
        // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
        Assert.assertTrue(runs.get(5).isDeleteRevision());
      • isMoveFromRevision

        public boolean isMoveFromRevision()
        
        Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.

        Example:

        Shows how to determine the revision type of an inline node.
        Document doc = new Document(getMyDir() + "Revision runs.docx");
        
        // When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
        // is turned on in Microsoft Word, the changes we apply count as revisions.
        // When editing a document using Aspose.Words, we can begin tracking revisions by
        // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method.
        // We can either accept revisions to assimilate them into the document
        // or reject them to change the proposed change effectively.
        Assert.assertEquals(6, doc.getRevisions().getCount());
        
        // The parent node of a revision is the run that the revision concerns. A Run is an Inline node.
        Run run = (Run) doc.getRevisions().get(0).getParentNode();
        
        Paragraph firstParagraph = run.getParentParagraph();
        RunCollection runs = firstParagraph.getRuns();
        
        Assert.assertEquals(runs.getCount(), 6);
        
        // Below are five types of revisions that can flag an Inline node.
        // 1 -  An "insert" revision:
        // This revision occurs when we insert text while tracking changes.
        Assert.assertTrue(runs.get(2).isInsertRevision());
        
        // 2 -  A "format" revision:
        // This revision occurs when we change the formatting of text while tracking changes.
        Assert.assertTrue(runs.get(2).isFormatRevision());
        
        // 3 -  A "move from" revision:
        // When we highlight text in Microsoft Word, and then drag it to a different place in the document
        // while tracking changes, two revisions appear.
        // The "move from" revision is a copy of the text originally before we moved it.
        Assert.assertTrue(runs.get(4).isMoveFromRevision());
        
        // 4 -  A "move to" revision:
        // The "move to" revision is the text that we moved in its new position in the document.
        // "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
        // Accepting a move revision deletes the "move from" revision and its text,
        // and keeps the text from the "move to" revision.
        // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
        Assert.assertTrue(runs.get(1).isMoveToRevision());
        
        // 5 -  A "delete" revision:
        // This revision occurs when we delete text while tracking changes. When we delete text like this,
        // it will stay in the document as a revision until we either accept the revision,
        // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
        Assert.assertTrue(runs.get(5).isDeleteRevision());
      • isMoveToRevision

        public boolean isMoveToRevision()
        
        Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.

        Example:

        Shows how to determine the revision type of an inline node.
        Document doc = new Document(getMyDir() + "Revision runs.docx");
        
        // When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
        // is turned on in Microsoft Word, the changes we apply count as revisions.
        // When editing a document using Aspose.Words, we can begin tracking revisions by
        // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method.
        // We can either accept revisions to assimilate them into the document
        // or reject them to change the proposed change effectively.
        Assert.assertEquals(6, doc.getRevisions().getCount());
        
        // The parent node of a revision is the run that the revision concerns. A Run is an Inline node.
        Run run = (Run) doc.getRevisions().get(0).getParentNode();
        
        Paragraph firstParagraph = run.getParentParagraph();
        RunCollection runs = firstParagraph.getRuns();
        
        Assert.assertEquals(runs.getCount(), 6);
        
        // Below are five types of revisions that can flag an Inline node.
        // 1 -  An "insert" revision:
        // This revision occurs when we insert text while tracking changes.
        Assert.assertTrue(runs.get(2).isInsertRevision());
        
        // 2 -  A "format" revision:
        // This revision occurs when we change the formatting of text while tracking changes.
        Assert.assertTrue(runs.get(2).isFormatRevision());
        
        // 3 -  A "move from" revision:
        // When we highlight text in Microsoft Word, and then drag it to a different place in the document
        // while tracking changes, two revisions appear.
        // The "move from" revision is a copy of the text originally before we moved it.
        Assert.assertTrue(runs.get(4).isMoveFromRevision());
        
        // 4 -  A "move to" revision:
        // The "move to" revision is the text that we moved in its new position in the document.
        // "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
        // Accepting a move revision deletes the "move from" revision and its text,
        // and keeps the text from the "move to" revision.
        // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
        Assert.assertTrue(runs.get(1).isMoveToRevision());
        
        // 5 -  A "delete" revision:
        // This revision occurs when we delete text while tracking changes. When we delete text like this,
        // it will stay in the document as a revision until we either accept the revision,
        // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
        Assert.assertTrue(runs.get(5).isDeleteRevision());
      • getMaxLength/setMaxLength

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

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • getName/setName

        public java.lang.String getName() / public void setName(java.lang.String value)
        
        Gets or sets the form field name. Microsoft Word allows strings with at most 20 characters.

        Example:

        Shows how to insert a combo box.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.write("Please select a fruit: ");
        
        // Insert a combo box which will allow a user to choose an option from a collection of strings.
        FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"Apple", "Banana", "Cherry"}, 0);
        
        Assert.assertEquals("MyComboBox", comboBox.getName());
        Assert.assertEquals(FieldType.FIELD_FORM_DROP_DOWN, comboBox.getType());
        Assert.assertEquals("Apple", comboBox.getResult());
        
        // The form field will appear in the form of a "select" html tag.
        doc.save(getArtifactsDir() + "FormFields.Create.html");
      • getNextSibling

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

        Example:

        Shows how to use a node's NextSibling property to enumerate through its immediate children.
        Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
        for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) {
            System.out.println(Node.nodeTypeToString(node.getNodeType()));
        }

        Example:

        Shows how to traverse a composite node's tree of child nodes.
        public void recurseChildren() throws Exception {
            Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
            // Any node that can contain child nodes, such as the document itself, is composite.
            Assert.assertTrue(doc.isComposite());
        
            // Invoke the recursive function that will go through and print all the child nodes of a composite node.
            traverseAllNodes(doc, 0);
        }
        
        /// <summary>
        /// Recursively traverses a node tree while printing the type of each node
        /// with an indent depending on depth as well as the contents of all inline nodes.
        /// </summary>
        @Test(enabled = false)
        public void traverseAllNodes(CompositeNode parentNode, int depth) {
            for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
                System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));
        
                // Recurse into the node if it is a composite node. Otherwise, print its contents if it is an inline node.
                if (childNode.isComposite()) {
                    System.out.println();
                    traverseAllNodes((CompositeNode) childNode, depth + 1);
                } else if (childNode instanceof Inline) {
                    System.out.println(" - \"{childNode.GetText().Trim()}\"");
                } else {
                    System.out.println();
                }
            }
        }
      • getNodeType

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

        Example:

        Shows how to traverse a composite node's tree of child nodes.
        public void recurseChildren() throws Exception {
            Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
            // Any node that can contain child nodes, such as the document itself, is composite.
            Assert.assertTrue(doc.isComposite());
        
            // Invoke the recursive function that will go through and print all the child nodes of a composite node.
            traverseAllNodes(doc, 0);
        }
        
        /// <summary>
        /// Recursively traverses a node tree while printing the type of each node
        /// with an indent depending on depth as well as the contents of all inline nodes.
        /// </summary>
        @Test(enabled = false)
        public void traverseAllNodes(CompositeNode parentNode, int depth) {
            for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
                System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));
        
                // Recurse into the node if it is a composite node. Otherwise, print its contents if it is an inline node.
                if (childNode.isComposite()) {
                    System.out.println();
                    traverseAllNodes((CompositeNode) childNode, depth + 1);
                } else if (childNode instanceof Inline) {
                    System.out.println(" - \"{childNode.GetText().Trim()}\"");
                } else {
                    System.out.println();
                }
            }
        }
      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • getParentNode

        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.

        Example:

        Shows how to access a node's parent node.
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // Append a child Run node to the document's first paragraph.
        Run run = new Run(doc, "Hello world!");
        para.appendChild(run);
        
        // The paragraph is the parent node of the run node. We can trace this lineage
        // all the way to the document node, which is the root of the document's node tree.
        Assert.assertEquals(para, run.getParentNode());
        Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
        Assert.assertEquals(doc.getFirstSection(), doc.getFirstSection().getBody().getParentNode());
        Assert.assertEquals(doc, doc.getFirstSection().getParentNode());

        Example:

        Shows how to create a node and set its owning document.
        Document doc = new Document();
        Paragraph para = new Paragraph(doc);
        para.appendChild(new Run(doc, "Hello world!"));
        
        // We have not yet appended this paragraph as a child to any composite node.
        Assert.assertNull(para.getParentNode());
        
        // If a node is an appropriate child node type of another composite node,
        // we can attach it as a child only if both nodes have the same owner document.
        // The owner document is the document we passed to the node's constructor.
        // We have not attached this paragraph to the document, so the document does not contain its text.
        Assert.assertEquals(para.getDocument(), doc);
        Assert.assertEquals("", doc.getText().trim());
        
        // Since the document owns this paragraph, we can apply one of its styles to the paragraph's contents.
        para.getParagraphFormat().setStyleName("Heading 1");
        
        // Add this node to the document, and then verify its contents.
        doc.getFirstSection().getBody().appendChild(para);
        
        Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
        Assert.assertEquals("Hello world!", doc.getText().trim());
      • getParentParagraph

        public Paragraph getParentParagraph()
        
        Retrieves the parent Paragraph of this node.

        Example:

        Shows how to determine the revision type of an inline node.
        Document doc = new Document(getMyDir() + "Revision runs.docx");
        
        // When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
        // is turned on in Microsoft Word, the changes we apply count as revisions.
        // When editing a document using Aspose.Words, we can begin tracking revisions by
        // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method.
        // We can either accept revisions to assimilate them into the document
        // or reject them to change the proposed change effectively.
        Assert.assertEquals(6, doc.getRevisions().getCount());
        
        // The parent node of a revision is the run that the revision concerns. A Run is an Inline node.
        Run run = (Run) doc.getRevisions().get(0).getParentNode();
        
        Paragraph firstParagraph = run.getParentParagraph();
        RunCollection runs = firstParagraph.getRuns();
        
        Assert.assertEquals(runs.getCount(), 6);
        
        // Below are five types of revisions that can flag an Inline node.
        // 1 -  An "insert" revision:
        // This revision occurs when we insert text while tracking changes.
        Assert.assertTrue(runs.get(2).isInsertRevision());
        
        // 2 -  A "format" revision:
        // This revision occurs when we change the formatting of text while tracking changes.
        Assert.assertTrue(runs.get(2).isFormatRevision());
        
        // 3 -  A "move from" revision:
        // When we highlight text in Microsoft Word, and then drag it to a different place in the document
        // while tracking changes, two revisions appear.
        // The "move from" revision is a copy of the text originally before we moved it.
        Assert.assertTrue(runs.get(4).isMoveFromRevision());
        
        // 4 -  A "move to" revision:
        // The "move to" revision is the text that we moved in its new position in the document.
        // "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
        // Accepting a move revision deletes the "move from" revision and its text,
        // and keeps the text from the "move to" revision.
        // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
        Assert.assertTrue(runs.get(1).isMoveToRevision());
        
        // 5 -  A "delete" revision:
        // This revision occurs when we delete text while tracking changes. When we delete text like this,
        // it will stay in the document as a revision until we either accept the revision,
        // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
        Assert.assertTrue(runs.get(5).isDeleteRevision());
      • getPreviousSibling

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

        Example:

        Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Section 1 text.");
        builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
        builder.writeln("Section 2 text.");
        
        // Both sections are siblings of each other.
        Section lastSection = (Section) doc.getLastChild();
        Section firstSection = (Section) lastSection.getPreviousSibling();
        
        // Remove a section based on its sibling relationship with another section.
        if (lastSection.getPreviousSibling() != null)
            doc.removeChild(firstSection);
        
        // The section we removed was the first one, leaving the document with only the second.
        Assert.assertEquals("Section 2 text.", doc.getText().trim());
      • getRange

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

        Example:

        Shows how to delete all the nodes from a range.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Add text to the first section in the document, and then add another section.
        builder.write("Section 1. ");
        builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
        builder.write("Section 2.");
        
        Assert.assertEquals("Section 1. \fSection 2.", doc.getText().trim());
        
        // Remove the first section entirely by removing all the nodes
        // within its range, including the section itself.
        doc.getSections().get(0).getRange().delete();
        
        Assert.assertEquals(1, doc.getSections().getCount());
        Assert.assertEquals("Section 2.", doc.getText().trim());
      • 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.

        Example:

        Shows how to insert a combo box.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.write("Please select a fruit: ");
        
        // Insert a combo box which will allow a user to choose an option from a collection of strings.
        FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"Apple", "Banana", "Cherry"}, 0);
        
        Assert.assertEquals("MyComboBox", comboBox.getName());
        Assert.assertEquals(FieldType.FIELD_FORM_DROP_DOWN, comboBox.getType());
        Assert.assertEquals("Apple", comboBox.getResult());
        
        // The form field will appear in the form of a "select" html tag.
        doc.save(getArtifactsDir() + "FormFields.Create.html");
      • 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.

        Microsoft Word allows strings with at most 138 characters.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • 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.

        Microsoft Word allows strings with at most 255 characters.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • 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.

        Microsoft Word allows strings with at most 64 characters.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • getType

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

        Example:

        Shows how to insert a combo box.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.write("Please select a fruit: ");
        
        // Insert a combo box which will allow a user to choose an option from a collection of strings.
        FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"Apple", "Banana", "Cherry"}, 0);
        
        Assert.assertEquals("MyComboBox", comboBox.getName());
        Assert.assertEquals(FieldType.FIELD_FORM_DROP_DOWN, comboBox.getType());
        Assert.assertEquals("Apple", comboBox.getResult());
        
        // The form field will appear in the form of a "select" html tag.
        doc.save(getArtifactsDir() + "FormFields.Create.html");
    • Method Detail

      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • deepClone

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

        Example:

        Shows how to clone a composite node.
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        para.appendChild(new Run(doc, "Hello world!"));
        
        // Below are two ways of cloning a composite node.
        // 1 -  Create a clone of a node, and create a clone of each of its child nodes as well.
        Node cloneWithChildren = para.deepClone(true);
        
        Assert.assertTrue(((CompositeNode) cloneWithChildren).hasChildNodes());
        Assert.assertEquals("Hello world!", cloneWithChildren.getText().trim());
        
        // 2 -  Create a clone of a node just by itself without any children.
        Node cloneWithoutChildren = para.deepClone(false);
        
        Assert.assertFalse(((CompositeNode) cloneWithoutChildren).hasChildNodes());
        Assert.assertEquals("", cloneWithoutChildren.getText().trim());
      • getAncestor

        public CompositeNode getAncestor(int ancestorType)
        Gets the first ancestor of the specified NodeType.
        Parameters:
        ancestorType - A NodeType value. The node type of the ancestor to retrieve.
        Returns:
        The ancestor of the specified type or null if no ancestor of this type was found.

        Example:

        Shows how to find out if a tables are nested.
        public void calculateDepthOfNestedTables() throws Exception {
            Document doc = new Document(getMyDir() + "Nested tables.docx");
            NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
        
            for (int i = 0; i < tables.getCount(); i++) {
                Table table = (Table) tables.get(i);
        
                // Find out if any cells in the table have other tables as children.
                int count = getChildTableCount(table);
                System.out.print(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count));
        
                // Find out if the table is nested inside another table, and, if so, at what depth.
                int tableDepth = getNestedDepthOfTable(table);
        
                if (tableDepth > 0)
                    System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth));
                else
                    System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i));
            }
        }
        
        /**
         * Calculates what level a table is nested inside other tables.
         *
         * @returns An integer containing the level the table is nested at.
         * 0 = Table is not nested inside any other table
         * 1 = Table is nested within one parent table
         * 2 = Table is nested within two parent tables etc..
         */
        private static int getNestedDepthOfTable(final Table table) {
            int depth = 0;
            Node parent = table.getAncestor(table.getNodeType());
        
            while (parent != null) {
                depth++;
                parent = parent.getAncestor(Table.class);
            }
        
            return depth;
        }
        
        /**
         * Determines if a table contains any immediate child table within its cells.
         * Does not recursively traverse through those tables to check for further tables.
         *
         * @returns Returns true if at least one child cell contains a table.
         * Returns false if no cells in the table contains a table.
         */
        private static int getChildTableCount(final Table table) {
            int childTableCount = 0;
        
            for (Row row : table.getRows()) {
                for (Cell cell : row.getCells()) {
                    TableCollection childTables = cell.getTables();
        
                    if (childTables.getCount() > 0) childTableCount++;
                }
            }
        
            return childTableCount;
        }
      • getAncestor

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

        Example:

        Shows how to find out if a tables are nested.
        public void calculateDepthOfNestedTables() throws Exception {
            Document doc = new Document(getMyDir() + "Nested tables.docx");
            NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
        
            for (int i = 0; i < tables.getCount(); i++) {
                Table table = (Table) tables.get(i);
        
                // Find out if any cells in the table have other tables as children.
                int count = getChildTableCount(table);
                System.out.print(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count));
        
                // Find out if the table is nested inside another table, and, if so, at what depth.
                int tableDepth = getNestedDepthOfTable(table);
        
                if (tableDepth > 0)
                    System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth));
                else
                    System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i));
            }
        }
        
        /**
         * Calculates what level a table is nested inside other tables.
         *
         * @returns An integer containing the level the table is nested at.
         * 0 = Table is not nested inside any other table
         * 1 = Table is nested within one parent table
         * 2 = Table is nested within two parent tables etc..
         */
        private static int getNestedDepthOfTable(final Table table) {
            int depth = 0;
            Node parent = table.getAncestor(table.getNodeType());
        
            while (parent != null) {
                depth++;
                parent = parent.getAncestor(Table.class);
            }
        
            return depth;
        }
        
        /**
         * Determines if a table contains any immediate child table within its cells.
         * Does not recursively traverse through those tables to check for further tables.
         *
         * @returns Returns true if at least one child cell contains a table.
         * Returns false if no cells in the table contains a table.
         */
        private static int getChildTableCount(final Table table) {
            int childTableCount = 0;
        
            for (Row row : table.getRows()) {
                for (Cell cell : row.getCells()) {
                    TableCollection childTables = cell.getTables();
        
                    if (childTables.getCount() > 0) childTableCount++;
                }
            }
        
            return childTableCount;
        }
      • getText

        public java.lang.String getText()
        Gets the special character that this node represents.
        Returns:
        The string that contains the character that this node represents.
      • nextPreOrder

        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

        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.
      • remove

        public void remove()
        Removes itself from the parent.

        Example:

        Shows how to remove all child nodes of a specific type from a composite node.
        Document doc = new Document(getMyDir() + "Tables.docx");
        
        Assert.assertEquals(2, doc.getChildNodes(NodeType.TABLE, true).getCount());
        
        Node curNode = doc.getFirstSection().getBody().getFirstChild();
        
        while (curNode != null) {
            // Save the next sibling node as a variable in case we want to move to it after deleting this node.
            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();
            }
        
            curNode = nextNode;
        }
        
        Assert.assertEquals(0, doc.getChildNodes(NodeType.TABLE, true).getCount());
      • 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.

        Example:

        Shows how to delete a form field.
        Document doc = new Document(getMyDir() + "Form fields.docx");
        
        FormField formField = doc.getRange().getFormFields().get(3);
        formField.removeField();
      • 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.

        Example:

        Shows how insert different kinds of form fields into a document, and process them with using a document visitor implementation.
        public void visitor() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Use a document builder to insert a combo box.
            builder.write("Choose a value from this combo box: ");
            FormField comboBox = builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 0);
            comboBox.setCalculateOnExit(true);
            Assert.assertEquals(3, comboBox.getDropDownItems().getCount());
            Assert.assertEquals(0, comboBox.getDropDownSelectedIndex());
            Assert.assertTrue(comboBox.getEnabled());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert a check box.
            builder.write("Click this check box to tick/untick it: ");
            FormField checkBox = builder.insertCheckBox("MyCheckBox", false, 50);
            checkBox.isCheckBoxExactSize(true);
            checkBox.setHelpText("Right click to check this box");
            checkBox.setOwnHelp(true);
            checkBox.setStatusText("Checkbox status text");
            checkBox.setOwnStatus(true);
            Assert.assertEquals(50.0d, checkBox.getCheckBoxSize());
            Assert.assertFalse(checkBox.getChecked());
            Assert.assertFalse(checkBox.getDefault());
        
            builder.insertBreak(BreakType.PARAGRAPH_BREAK);
        
            // Use a document builder to insert text input form field.
            builder.write("Enter text here: ");
            FormField textInput = builder.insertTextInput("MyTextInput", TextFormFieldType.REGULAR, "", "Placeholder text", 50);
            textInput.setEntryMacro("EntryMacro");
            textInput.setExitMacro("ExitMacro");
            textInput.setTextInputDefault("Regular");
            textInput.setTextInputFormat("FIRST CAPITAL");
            textInput.setTextInputValue("New placeholder text");
            Assert.assertEquals(TextFormFieldType.REGULAR, textInput.getTextInputType());
            Assert.assertEquals(50, textInput.getMaxLength());
        
            // This collection contains all our form fields.
            FormFieldCollection formFields = doc.getRange().getFormFields();
            Assert.assertEquals(3, formFields.getCount());
        
            // Fields display our form fields. We can see their field codes by opening this document
            // in Microsoft and pressing Alt + F9. These fields have no switches,
            // and members of the FormField object fully govern their form fields' content.
            Assert.assertEquals(3, doc.getRange().getFields().getCount());
            Assert.assertEquals(" FORMDROPDOWN \u0001", doc.getRange().getFields().get(0).getFieldCode());
            Assert.assertEquals(" FORMCHECKBOX \u0001", doc.getRange().getFields().get(1).getFieldCode());
            Assert.assertEquals(" FORMTEXT \u0001", doc.getRange().getFields().get(2).getFieldCode());
        
            // Allow each form field to accept a document visitor.
            FormFieldVisitor formFieldVisitor = new FormFieldVisitor();
        
            Iterator<FormField> fieldEnumerator = formFields.iterator();
            while (fieldEnumerator.hasNext())
                fieldEnumerator.next().accept(formFieldVisitor);
        
            System.out.println(formFieldVisitor.getText());
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "FormFields.Visitor.html");
        }
        
        /// <summary>
        /// Visitor implementation that prints details of form fields that it visits. 
        /// </summary>
        public static class FormFieldVisitor extends DocumentVisitor {
            public FormFieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Called when a FormField node is encountered in the document.
            /// </summary>
            public /*override*/ /*VisitorAction*/int visitFormField(FormField formField) {
                appendLine(formField.getType() + ": \"" + formField.getName() + "\"");
                appendLine("\tStatus: " + (formField.getEnabled() ? "Enabled" : "Disabled"));
                appendLine("\tHelp Text:  " + formField.getHelpText());
                appendLine("\tEntry macro name: " + formField.getEntryMacro());
                appendLine("\tExit macro name: " + formField.getExitMacro());
        
                switch (formField.getType()) {
                    case FieldType.FIELD_FORM_DROP_DOWN:
                        appendLine("\tDrop down items count: " + formField.getDropDownItems().getCount() + ", default selected item index: " + formField.getDropDownSelectedIndex());
                        appendLine("\tDrop down items: " + String.join(", ", formField.getDropDownItems()));
                        break;
                    case FieldType.FIELD_FORM_CHECK_BOX:
                        appendLine("\tCheckbox size: " + formField.getCheckBoxSize());
                        appendLine("\t" + "Checkbox is currently: " + (formField.getChecked() ? "checked, " : "unchecked, ") + "by default: " + (formField.getDefault() ? "checked" : "unchecked"));
                        break;
                    case FieldType.FIELD_FORM_TEXT_INPUT:
                        appendLine("\tInput format: " + formField.getTextInputFormat());
                        appendLine("\tCurrent contents: " + formField.getResult());
                        break;
                }
        
                // Let the visitor continue visiting other nodes.
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Adds newline char-terminated text to the current output.
            /// </summary>
            private void appendLine(String text) {
                mBuilder.append(text + '\n');
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            private final StringBuilder mBuilder;
        }
      • toString

        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.

        Example:

        Exports the content of a node to String in HTML format.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When we call the ToString method using the html SaveFormat overload,
        // it converts the node's contents to their raw html representation.
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(SaveFormat.HTML));
        
        // We can also modify the result of this conversion using a SaveOptions object.
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setExportRelativeFontSize(true);
        
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(saveOptions));
      • toString

        public java.lang.String toString(int saveFormat)
                       throws java.lang.Exception
        Exports the content of the node into a string in the specified format.
        Returns:
        The content of the node in the specified format.
        Parameters:
        saveFormat - A SaveFormat value.

        Example:

        Shows how to extract the list labels of all paragraphs that are list items.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        doc.updateListLabels();
        int listParaCount = 1;
        
        for (Paragraph paragraph : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
            // Find if we have the paragraph list. In our document, our list uses plain Arabic numbers,
            // which start at three and ends at six.
            if (paragraph.getListFormat().isListItem()) {
                System.out.println(MessageFormat.format("List item paragraph #{0}", listParaCount));
        
                // This is the text we get when getting when we output this node to text format.
                // This text output will omit list labels. Trim any paragraph formatting characters. 
                String paragraphText = paragraph.toString(SaveFormat.TEXT).trim();
                System.out.println("Exported Text: " + paragraphText);
        
                ListLabel label = paragraph.getListLabel();
        
                // This gets the position of the paragraph in the current level of the list. If we have a list with multiple levels,
                // this will tell us what position it is on that level.
                System.out.println("\tNumerical Id: {label.LabelValue}");
        
                // Combine them together to include the list label with the text in the output.
                System.out.println("\tList label combined with text: {label.LabelString} {paragraphText}");
            }

        Example:

        Exports the content of a node to String in HTML format.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When we call the ToString method using the html SaveFormat overload,
        // it converts the node's contents to their raw html representation.
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(SaveFormat.HTML));
        
        // We can also modify the result of this conversion using a SaveOptions object.
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setExportRelativeFontSize(true);
        
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(saveOptions));

        Example:

        Shows the difference between calling the GetText and ToString methods on a node.
        Document doc = new Document();
        
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertField("MERGEFIELD Field");
        
        // GetText will retrieve the visible text as well as field codes and special characters.
        Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());
        
        // ToString will give us the document's appearance if saved to a passed save format.
        Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));