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 work with form field name, type, and result.
Document doc = new Document(getMyDir() + "FormFields.doc");

FormField formField = doc.getRange().getFormFields().get(3);

if (formField.getType() == FieldType.FIELD_FORM_TEXT_INPUT)
    formField.setResult("My name is " + formField.getName());

Example:

Shows how to access form fields.
Document doc = new Document(getMyDir() + "FormFields.doc");
FormFieldCollection documentFormFields = doc.getRange().getFormFields();

FormField formField1 = documentFormFields.get(3);
FormField formField2 = documentFormFields.get("CustomerName");

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

      • getCheckBoxSize/setCheckBoxSize

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

        Applicable for a check box form field only.

        See Also:
        IsCheckBoxExactSize
      • getChecked/setChecked

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

        Applicable for a check box form field only.

      • getDefault/setDefault

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

        Applicable for a check box form field only.

      • getDocument

        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 that when you create any node, it requires a document that will own the node.
        // Open a file from disk.
        Document doc = new Document();
        
        // Creating a new node of any type requires a document passed into the constructor.
        Paragraph para = new Paragraph(doc);
        
        // The new paragraph node does not yet have a parent.
        System.out.println("Paragraph has no parent node: " + (para.getParentNode() == null));
        
        // But the paragraph node knows its document.
        System.out.println("Both nodes' documents are the same: " + (para.getDocument() == doc));
        
        // The fact that a node always belongs to a document allows us to access and modify
        // properties that reference the document-wide data such as styles or lists.
        para.getParagraphFormat().setStyleName("Heading 1");
        
        // Now add the paragraph to the main text of the first section.
        doc.getFirstSection().getBody().appendChild(para);
        
        // The paragraph node is now a child of the Body node.
        System.out.println("Paragraph has a parent node: " + (para.getParentNode() != null));
      • getDropDownItems

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

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

      • getDropDownSelectedIndex/setDropDownSelectedIndex

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

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

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

      • getEntryMacro/setEntryMacro

        public java.lang.String getEntryMacro() / public void setEntryMacro(java.lang.String value)
        
        Returns or sets an entry macro name for the form field.

        The entry macro runs when the form field gets the focus in Microsoft Word.

        Microsoft Word allows strings with at most 32 characters.

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

      • getFont

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

        Example:

        Creates a simple document from scratch using the Aspose.Words object model.
        // Create an "empty" document. Note that like in Microsoft Word,
        // the empty document has one section, body and one paragraph in it.
        Document doc = new Document();
        
        // This truly makes the document empty. No sections (not possible in Microsoft Word).
        doc.removeAllChildren();
        
        // Create a new section node.
        // Note that the section has not yet been added to the document,
        // but we have to specify the parent document.
        Section section = new Section(doc);
        
        // Append the section to the document.
        doc.appendChild(section);
        
        // Lets set some properties for the section.
        section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
        section.getPageSetup().setPaperSize(PaperSize.LETTER);
        
        // The section that we created is empty, lets populate it. The section needs at least the Body node.
        Body body = new Body(doc);
        section.appendChild(body);
        
        // The body needs to have at least one paragraph.
        // Note that the paragraph has not yet been added to the document,
        // but we have to specify the parent document.
        // The parent document is needed so the paragraph can correctly work
        // with styles and other document-wide information.
        Paragraph para = new Paragraph(doc);
        body.appendChild(para);
        
        // We can set some formatting for the paragraph
        para.getParagraphFormat().setStyleName("Heading 1");
        para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        
        // So far we have one empty paragraph in the document.
        // The document is valid and can be saved, but lets add some text before saving.
        // Create a new run of text and add it to our paragraph.
        Run run = new Run(doc);
        run.setText("Hello World!");
        run.getFont().setColor(Color.RED);
        para.appendChild(run);
        
        // As a matter of interest, you can retrieve text of the whole document and
        // see that \x000c is automatically appended. \x000c is the end of section character.
        System.out.println(doc.getText());
        
        // Save the document.
        doc.save(getMyDir() + "\\Artifacts\\Section.CreateFromScratch.doc");
      • 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.

      • isCheckBoxExactSize/isCheckBoxExactSize

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

        Applicable for a check box form field only.

        See Also:
        CheckBoxSize
      • isComposite

        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 efficiently visit all direct and indirect children of a composite node.
        public void recurseAllNodes() throws Exception
        {
            // Open a document.
            Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc");
        
            // Invoke the recursive function that will walk the tree.
            traverseAllNodes(doc);
        }
        
        /**
         * A simple function that will walk through all children of a specified node recursively
         * and print the type of each node to the screen.
         */
        public void traverseAllNodes(CompositeNode parentNode)
        {
            // This is the most efficient way to loop through immediate children of a node.
            for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling())
            {
                // Do some useful work.
                System.out.println(Node.nodeTypeToString(childNode.getNodeType()));
        
                // Recurse into the node if it is a composite node.
                if (childNode.isComposite()) traverseAllNodes((CompositeNode) childNode);
            }
        }
      • isDeleteRevision

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

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

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

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

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

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

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

        Example:

        Shows how to work with form field name, type, and result.
        Document doc = new Document(getMyDir() + "FormFields.doc");
        
        FormField formField = doc.getRange().getFormFields().get(3);
        
        if (formField.getType() == FieldType.FIELD_FORM_TEXT_INPUT)
            formField.setResult("My name is " + formField.getName());
      • 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 enumerate immediate child nodes of a composite node using NextSibling. In this example we enumerate all paragraphs of a section body.
        // Get the section that we want to work on.
        Section section = doc.getSections().get(0);
        Body body = section.getBody();
        
        // Loop starting from the first child until we reach null.
        for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling())
        {
            // Output the types of the nodes that we come across.
            System.out.println(Node.nodeTypeToString(node.getNodeType()));
        }

        Example:

        Shows how to efficiently visit all direct and indirect children of a composite node.
        public void recurseAllNodes() throws Exception
        {
            // Open a document.
            Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc");
        
            // Invoke the recursive function that will walk the tree.
            traverseAllNodes(doc);
        }
        
        /**
         * A simple function that will walk through all children of a specified node recursively
         * and print the type of each node to the screen.
         */
        public void traverseAllNodes(CompositeNode parentNode)
        {
            // This is the most efficient way to loop through immediate children of a node.
            for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling())
            {
                // Do some useful work.
                System.out.println(Node.nodeTypeToString(childNode.getNodeType()));
        
                // Recurse into the node if it is a composite node.
                if (childNode.isComposite()) traverseAllNodes((CompositeNode) childNode);
            }
        }
      • getNodeType

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

        Example:

        Shows how to retrieve the NodeType enumeration of nodes.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // Let's pick a node that we can't be quite sure of what type it is.
        // In this case lets pick the first node of the first paragraph in the body of the document
        Node node = doc.getFirstSection().getBody().getFirstParagraph().getFirstChild();
        System.out.println("NodeType of first child: " + Node.nodeTypeToString(node.getNodeType()));
        
        // This time let's pick a node that we know the type of. Create a new paragraph and a table node.
        Paragraph para = new Paragraph(doc);
        Table table = new Table(doc);
        
        // Access to NodeType for typed nodes will always return their specific NodeType.
        // i.e A paragraph node will always return NodeType.Paragraph, a table node will always return NodeType.Table.
        System.out.println("NodeType of Paragraph: " + Node.nodeTypeToString(para.getNodeType()));
        System.out.println("NodeType of Table: " + Node.nodeTypeToString(table.getNodeType()));
      • getOwnHelp/setOwnHelp

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

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

      • getOwnStatus/setOwnStatus

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

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

      • getParentNode

        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 the parent node.
        // Create a new empty document. It has one section.
        Document doc = new Document();
        
        // The section is the first child node of the document.
        Node section = doc.getFirstChild();
        
        // The section's parent node is the document.
        System.out.println("Section parent is the document: " + (doc == section.getParentNode()));

        Example:

        Shows that when you create any node, it requires a document that will own the node.
        // Open a file from disk.
        Document doc = new Document();
        
        // Creating a new node of any type requires a document passed into the constructor.
        Paragraph para = new Paragraph(doc);
        
        // The new paragraph node does not yet have a parent.
        System.out.println("Paragraph has no parent node: " + (para.getParentNode() == null));
        
        // But the paragraph node knows its document.
        System.out.println("Both nodes' documents are the same: " + (para.getDocument() == doc));
        
        // The fact that a node always belongs to a document allows us to access and modify
        // properties that reference the document-wide data such as styles or lists.
        para.getParagraphFormat().setStyleName("Heading 1");
        
        // Now add the paragraph to the main text of the first section.
        doc.getFirstSection().getBody().appendChild(para);
        
        // The paragraph node is now a child of the Body node.
        System.out.println("Paragraph has a parent node: " + (para.getParentNode() != null));
      • getParentParagraph

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

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

        Example:

        Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.
        // Document is a CompositeNode and LastChild returns the last child node in the Document node.
        // Since the Document can contain only Section nodes, the last child is the last section.
        Node lastSection = doc.getLastChild();
        
        // Each node knows its next and previous sibling nodes.
        // Previous sibling of a section is a section before the specified section.
        // If the node is the first child, PreviousSibling will return null.
        Node sectionBeforeLast = lastSection.getPreviousSibling();
        
        if (sectionBeforeLast != null) doc.removeChild(sectionBeforeLast);
      • 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 characters of a range.
        // Open Word document.
        Document doc = new Document(getMyDir() + "Range.DeleteSection.doc");
        
        // The document contains two sections. Each section has a paragraph of text.
        System.out.println(doc.getText());
        
        // Delete the first section from the document.
        doc.getSections().get(0).getRange().delete();
        
        // Check the first section was deleted by looking at the text of the whole document again.
        System.out.println(doc.getText());
      • 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 work with form field name, type, and result.
        Document doc = new Document(getMyDir() + "FormFields.doc");
        
        FormField formField = doc.getRange().getFormFields().get(3);
        
        if (formField.getType() == FieldType.FIELD_FORM_TEXT_INPUT)
            formField.setResult("My name is " + formField.getName());
      • 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.

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

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

      • getTextInputType/setTextInputType

        public int getTextInputType() / public void setTextInputType(int value)
        
        Gets or sets the type of a text form field. The value of the property is TextFormFieldType integer constant.
      • getType

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

        Example:

        Shows how to work with form field name, type, and result.
        Document doc = new Document(getMyDir() + "FormFields.doc");
        
        FormField formField = doc.getRange().getFormFields().get(3);
        
        if (formField.getType() == FieldType.FIELD_FORM_TEXT_INPUT)
            formField.setResult("My name is " + formField.getName());
    • 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.
      • deepClone

        public Node deepClone(boolean isCloneChildren)

        Example:

        Shows how to clone composite nodes with and without their child nodes.
        // Create a new empty document.
        Document doc = new Document();
        
        // Add some text to the first paragraph
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        para.appendChild(new Run(doc, "Some text"));
        
        // Clone the paragraph and the child nodes.
        Node cloneWithChildren = para.deepClone(true);
        // Only clone the paragraph and no child nodes.
        Node cloneWithoutChildren = para.deepClone(false);
      • 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 table contains another table or if the table itself is nested inside another table.
        public void calculateDepthOfNestedTables() throws Exception
        {
            Document doc = new Document(getMyDir() + "Table.NestedTables.doc");
            int tableIndex = 0;
        
            for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true))
            {
                // First lets find if any cells in the table have tables themselves as children.
                int count = getChildTableCount(table);
                System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count));
        
                // Now let's try the other way around, lets try find if the table is nested inside another table and 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}", tableIndex, tableDepth));
                else
                    System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex));
        
                tableIndex++;
            }
        }
        
        /**
         * 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(Table table)
        {
            int depth = 0;
        
            int type = table.getNodeType();
            // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table
            Node parent = table.getAncestor(type);
        
            while (parent != null)
            {
                // Every time we find a table a level up we increase the depth counter and then try to find an
                // ancestor of type table from the parent.
                depth++;
                parent = parent.getAncestor(type);
            }
        
            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(Table table)
        {
            int tableCount = 0;
            // Iterate through all child rows in the table
            for (Row row : table.getRows())
            {
                // Iterate through all child cells in the row
                for (Cell Cell : row.getCells())
                {
                    // Retrieve the collection of child tables of this cell
                    TableCollection childTables = Cell.getTables();
        
                    // If this cell has a table as a child then return true
                    if (childTables.getCount() > 0) tableCount++;
                }
            }
        
            // No cell contains a table
            return tableCount;
        }
      • 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.
      • 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.

        Example:

        Shows how to delete all images from a document using pre-order tree traversal.
        Node curNode = doc;
        while (curNode != null)
        {
            Node nextNode = curNode.nextPreOrder(doc);
        
            if (curNode.getNodeType() == NodeType.SHAPE)
            {
                Shape shape = (Shape) curNode;
        
                // Several shape types can have an image including image shapes and OLE objects.
                if (shape.hasImage()) shape.remove();
            }
        
            curNode = nextNode;
        }
      • 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 nodes of a specific type from a composite node. In this example we remove tables from a section body.
        // Get the section that we want to work on.
        Section section = doc.getSections().get(0);
        Body body = section.getBody();
        
        // Select the first child node in the body.
        Node curNode = body.getFirstChild();
        
        while (curNode != null)
        {
            // Save the pointer to the next sibling node because if the current
            // node is removed from the parent in the next step, we will have
            // no way of finding the next node to continue the loop.
            Node nextNode = curNode.getNextSibling();
        
            // A section body can contain Paragraph and Table nodes.
            // If the node is a Table, remove it from the parent.
            if (curNode.getNodeType() == NodeType.TABLE) curNode.remove();
        
            // Continue going through child nodes until null (no more siblings) is reached.
            curNode = nextNode;
        }

        Example:

        Shows how to delete all images from a document.
        // Here we get all shapes from the document node, but you can do this for any smaller
        // node too, for example delete shapes from a single section or a paragraph.
        NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
        
        // We cannot delete shape nodes while we enumerate through the collection.
        // One solution is to add nodes that we want to delete to a temporary array and delete afterwards.
        ArrayList shapesToDelete = new ArrayList();
        for (Shape shape : (Iterable<Shape>) shapes)
        {
            // Several shape types can have an image including image shapes and OLE objects.
            if (shape.hasImage()) shapesToDelete.add(shape);
        }
        
        // Now we can delete shapes.
        for (Shape shape : (Iterable<Shape>) shapesToDelete)
            shape.remove();
      • 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 complete form field
        Document doc = new Document(getMyDir() + "FormFields.doc");
        
        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.
      • 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 using custom specified options.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // Extract the last paragraph in the document to convert to HTML.
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // Create an instance of HtmlSaveOptions and set a few options.
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setExportHeadersFootersMode(ExportHeadersFootersMode.PER_SECTION);
        saveOptions.setExportRelativeFontSize(true);
        
        // Convert the document to HTML and return as a string. Pass the instance of HtmlSaveOptions to
        // to use the specified options during the conversion.
        String nodeAsHtml = 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 label of each paragraph in a list as a value or a String.
        Document doc = new Document(getMyDir() + "Lists.PrintOutAllLists.doc");
        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("Paragraph #{0}", listParaCount));
        
                // This is the text we get when actually getting when we output this node to text format.
                // The list labels are not included in this text output. 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 current level of the list. If we have a list with multiple level then this
                // will tell us what position it is on that particular level.
                System.out.println("Numerical Id: " + label.getLabelValue());
        
                // Combine them together to include the list label with the text in the output.
                System.out.println("List label combined with text: " + label.getLabelString() + " " + paragraphText);
        
                listParaCount++;
            }
        }

        Example:

        Shows the difference between calling the GetText and ToString methods on a node.
        Document doc = new Document();
        
        // Enter a dummy field into the document.
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertField("MERGEFIELD Field");
        
        // GetText will retrieve all field codes and special characters
        System.out.println("GetText() Result: " + doc.getText());
        
        // ToString will export the node to the specified format. When converted to text it will not retrieve fields code
        // or special characters, but will still contain some natural formatting characters such as paragraph markers etc.
        // This is the same as "viewing" the document as if it was opened in a text editor.
        System.out.println("ToString() Result: " + doc.toString(SaveFormat.TEXT));

        Example:

        Exports the content of a node to string in HTML format using default options.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // Extract the last paragraph in the document to convert to HTML.
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When ToString is called using the SaveFormat overload then conversion is executed using default save options.
        // When saving to HTML using default options the following settings are set:
        //   ExportImagesAsBase64 = true
        //   CssStyleSheetType = CssStyleSheetType.Inline
        //   ExportFontResources = false
        String nodeAsHtml = node.toString(SaveFormat.HTML);