com.aspose.words

  • All Implemented Interfaces:
    java.lang.Iterable, java.lang.Cloneable
    public class Body 
    extends Story

Represents a container for the main text of a section.

Body can contain Paragraph and Table child nodes.

Body is a section-level node and can only be a child of Section. There can only be one Body in a Section.

A minimal valid Body needs to contain at least one Paragraph.

Example:

Shows how to construct an Aspose Words document node by node.
Document doc = new Document();

// A newly created blank document still comes one section, one body and one paragraph
// Calling this method will remove all those nodes to completely empty the document
doc.removeAllChildren();

// This document now has no composite nodes that content can be added to
// If we wish to edit it, we will need to repopulate its node collection,
// which we will start to do with by creating a new Section node
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);

Assert.assertEquals("Hello World!" + ControlChar.SECTION_BREAK_CHAR, doc.getText());

doc.save(getArtifactsDir() + "Section.CreateFromScratch.docx");

Constructor Summary
Body(DocumentBase doc)
Initializes a new instance of the Body class.
 
Property Getters/Setters Summary
NodeCollectiongetChildNodes()
Gets all immediate child nodes of this node.
intgetCount()
Gets the number of immediate children of this node.
DocumentBasegetDocument()
Gets the document to which this node belongs.
NodegetFirstChild()
Gets the first child of the node.
ParagraphgetFirstParagraph()
Gets the first paragraph in the story.
booleanhasChildNodes()
Returns true if this node has any child nodes.
booleanisComposite()
Returns true as this node can have child nodes.
NodegetLastChild()
Gets the last child of the node.
ParagraphgetLastParagraph()
Gets the last paragraph in the story.
NodegetNextSibling()
Gets the node immediately following this node.
intgetNodeType()
Returns NodeType.Body. The value of the property is NodeType integer constant.
ParagraphCollectiongetParagraphs()
Gets a collection of paragraphs that are immediate children of the story.
CompositeNodegetParentNode()
Gets the immediate parent of this node.
SectiongetParentSection()
Gets the parent section of this story.
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.
intgetStoryType()
Gets the type of this story. The value of the property is StoryType integer constant.
TableCollectiongetTables()
Gets a collection of tables that are immediate children of the story.
 
Method Summary
booleanaccept(DocumentVisitor visitor)
Accepts a visitor.
NodeappendChild(Node newChild)
Adds the specified node to the end of the list of child nodes for this node.
ParagraphappendParagraph(java.lang.String text)
A shortcut method that creates a Paragraph object with optional text and appends it to the end of this object.
NodedeepClone(boolean isCloneChildren)
voiddeleteShapes()
Deletes all shapes from the text of this story.
voidensureMinimum()
If the last child is not a paragraph, creates and appends one empty paragraph.
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.
NodegetChild(int nodeType, int index, boolean isDeep)
Returns an Nth child node that matches the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep)
Returns a live collection of child nodes that match the specified type.
java.lang.StringgetText()
Gets the text of this node and of all its children.
intindexOf(Node child)
Returns the index of the specified child node in the child node array.
NodeinsertAfter(Node newChild, Node refChild)
Inserts the specified node immediately after the specified reference node.
NodeinsertBefore(Node newChild, Node refChild)
Inserts the specified node immediately before the specified reference node.
java.util.Iterator<Node>iterator()
Provides support for the for each style iteration over the child nodes of this node.
NodenextPreOrder(Node rootNode)
Gets next node according to the pre-order tree traversal algorithm.
NodeprependChild(Node newChild)
Adds the specified node to the beginning of the list of child nodes for this node.
NodepreviousPreOrder(Node rootNode)
Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()
Removes itself from the parent.
voidremoveAllChildren()
Removes all the child nodes of the current node.
NoderemoveChild(Node oldChild)
Removes the specified child node.
voidremoveSmartTags()
Removes all SmartTag descendant nodes of the current node.
NodeListselectNodes(java.lang.String xpath)
Selects a list of nodes matching the XPath expression.
NodeselectSingleNode(java.lang.String xpath)
Selects the first Node that matches the XPath expression.
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.
 

    • Constructor Detail

      • Body

        public Body(DocumentBase doc)
        Initializes a new instance of the Body class.

        When Body is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.

        To append Body to a Section use Section.InsertAfter or Section.InsertBefore.

        Parameters:
        doc - The owner document.

        Example:

        Shows how to construct an Aspose Words document node by node.
        Document doc = new Document();
        
        // A newly created blank document still comes one section, one body and one paragraph
        // Calling this method will remove all those nodes to completely empty the document
        doc.removeAllChildren();
        
        // This document now has no composite nodes that content can be added to
        // If we wish to edit it, we will need to repopulate its node collection,
        // which we will start to do with by creating a new Section node
        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);
        
        Assert.assertEquals("Hello World!" + ControlChar.SECTION_BREAK_CHAR, doc.getText());
        
        doc.save(getArtifactsDir() + "Section.CreateFromScratch.docx");
    • Property Getters/Setters Detail

      • getChildNodes

        public NodeCollection getChildNodes()
        
        Gets all immediate child nodes of this node.

        Note, ChildNodes is equivalent to calling GetChildNodes(NodeType.Any, false) and creates and returns a new collection every time it is accessed.

        If there are no child nodes, this property returns an empty collection.

        Example:

        Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.
        Document doc = new Document();
        
        Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
        paragraph.appendChild(new Run(doc, "Hello world!"));
        paragraph.appendChild(new Run(doc, " Hello again!"));
        
        NodeCollection children = paragraph.getChildNodes();
        
        // Paragraph may contain children of various types such as runs, shapes and so on
        for (Node child : (Iterable<Node>) children)
            if (((child.getNodeType()) == (NodeType.RUN))) {
                Run run = (Run) child;
                System.out.println(run.getText());
            }
      • getCount

        public int getCount()
        
        Gets the number of immediate children of this node.

        Example:

        Shows how to add, update and delete child nodes from a CompositeNode's child collection.
        Document doc = new Document();
        
        // An empty document has one paragraph by default
        Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
        
        // A paragraph is a composite node because it can contain runs, which are another type of node
        Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
        Run paragraphText = new Run(doc, "Initial text. ");
        paragraph.appendChild(paragraphText);
        
        // We will place these 3 children into the main text of our paragraph
        Run run1 = new Run(doc, "Run 1. ");
        Run run2 = new Run(doc, "Run 2. ");
        Run run3 = new Run(doc, "Run 3. ");
        
        // We initialized them but not in our paragraph yet
        Assert.assertEquals("Initial text.", paragraph.getText().trim());
        
        // Insert run2 before initial paragraph text. This will be at the start of the paragraph
        paragraph.insertBefore(run2, paragraphText);
        
        // Insert run3 after initial paragraph text. This will be at the end of the paragraph
        paragraph.insertAfter(run3, paragraphText);
        
        // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1
        paragraph.prependChild(run1);
        
        Assert.assertEquals("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim());
        Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount());
        
        // Access the child node collection and update/delete children
        ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
        paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);
        
        Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
        Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());
      • 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.
        // 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));
      • getFirstChild

        public Node getFirstChild()
        
        Gets the first child of the node. If there is no first child node, a null is returned.

        Example:

        Shows how to enumerate immediate child nodes of a composite node using NextSibling.
        Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
        // Loop starting from the first child until we reach null
        for (Node node = doc.getFirstSection().getBody().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 {
            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) {
            // Loop through immediate children of a node
            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
                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();
                }
            }
        }
      • getFirstParagraph

        public Paragraph getFirstParagraph()
        
        Gets the first paragraph in the story.

        Example:

        Shows how to add a formatted run of text to a document using the object model.
        Document doc = new Document();
        
        // Create a new run of text
        Run run = new Run(doc, "Hello");
        
        // Specify character formatting for the run of text
        Font f = run.getFont();
        f.setName("Courier New");
        f.setSize(36.0);
        f.setHighlightColor(Color.YELLOW);
        
        // Append the run of text to the end of the first paragraph
        // in the body of the first section of the document
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(run);

        Example:

        Shows how to create a textbox with some text and different formatting options in a new document.
        Document doc = new Document();
        
        // Create a new shape of type TextBox
        Shape textBox = new Shape(doc, ShapeType.TEXT_BOX);
        
        // Set some settings of the textbox itself
        // Set the wrap of the textbox to inline
        textBox.setWrapType(WrapType.NONE);
        // Set the horizontal and vertical alignment of the text inside the shape
        textBox.setHorizontalAlignment(HorizontalAlignment.CENTER);
        textBox.setVerticalAlignment(VerticalAlignment.TOP);
        
        // Set the textbox height and width
        textBox.setHeight(50.0);
        textBox.setWidth(200.0);
        
        // Set the textbox in front of other shapes with a lower ZOrder
        textBox.setZOrder(2);
        
        // Let's create a new paragraph for the textbox manually and align it in the center
        // Make sure we add the new nodes to the textbox as well
        textBox.appendChild(new Paragraph(doc));
        Paragraph para = textBox.getFirstParagraph();
        para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        
        // Add some text to the paragraph
        Run run = new Run(doc);
        run.setText("Hello world!");
        para.appendChild(run);
        
        // Append the textbox to the first paragraph in the body
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(textBox);
        
        doc.save(getArtifactsDir() + "Shape.CreateTextBox.docx");
      • hasChildNodes

        public boolean hasChildNodes()
        
        Returns true if this node has any child nodes.

        Example:

        Shows how to combine the rows from two tables into one.
        // Load the document
        Document doc = new Document(getMyDir() + "Tables.docx");
        
        // Get the first and second table in the document
        // The rows from the second table will be appended to the end of the first table
        Table firstTable = (Table) doc.getChild(NodeType.TABLE, 0, true);
        Table secondTable = (Table) doc.getChild(NodeType.TABLE, 1, true);
        
        // Append all rows from the current table to the next
        // Due to the design of tables even tables with different cell count and widths can be joined into one table
        while (secondTable.hasChildNodes())
            firstTable.getRows().add(secondTable.getFirstRow());
        
        // Remove the empty table container
        secondTable.remove();
        
        doc.save(getArtifactsDir() + "Table.CombineTables.docx");
      • isComposite

        public boolean isComposite()
        
        Returns true as this node can have child nodes.

        Example:

        Shows how to efficiently visit all direct and indirect children of a composite node.
        public void recurseAllNodes() 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) {
            // Loop through immediate children of a node
            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
                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();
                }
            }
        }
      • getLastChild

        public Node getLastChild()
        
        Gets the last child of the node. If there is no last child 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);
        
        // Create a second section by inserting a section break and add text to both sections
        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());
      • getLastParagraph

        public Paragraph getLastParagraph()
        
        Gets the last paragraph in the story.

        Example:

        Shows how to move a DocumentBuilder's cursor position to a specified node.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Write a paragraph with the DocumentBuilder
        builder.writeln("Text 1. ");
        
        // Move the DocumentBuilder to the first paragraph of the document and add another paragraph
        builder.moveTo(doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(0));
        builder.writeln("Text 2. ");
        
        // Since we moved to a node before the first paragraph before we added a second paragraph,
        // the second paragraph will appear in front of the first paragraph
        Assert.assertEquals("Text 2. \rText 1.", doc.getText().trim());
        
        // We can move the DocumentBuilder back to the end of the document like this
        // and carry on adding text to the end of the document
        builder.moveTo(doc.getFirstSection().getBody().getLastParagraph());
        builder.writeln("Text 3. ");
        
        Assert.assertEquals("Text 2. \rText 1. \rText 3.", doc.getText().trim());
      • 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.
        Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
        // Loop starting from the first child until we reach null
        for (Node node = doc.getFirstSection().getBody().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 {
            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) {
            // Loop through immediate children of a node
            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
                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.Body. The value of the property is NodeType integer constant.

        Example:

        Shows how you can enumerate through children of a composite node and detect types of the children nodes.
        // Open a document
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.write("Section 1");
        builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
        builder.write("Primary header");
        builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
        builder.write("Primary footer");
        
        // Get the first section in the document
        Section section = doc.getFirstSection();
        
        // A Section is a composite node and therefore can contain child nodes
        // Section can contain only Body and HeaderFooter nodes
        for (Node node : section) {
            // Every node has the NodeType property
            switch (node.getNodeType()) {
                case NodeType.BODY:
                    // If the node type is Body, we can cast the node to the Body class
                    Body body = (Body) node;
        
                    // Write the content of the main story of the section to the console
                    System.out.println("*** Body ***");
                    System.out.println(body.getText());
                    break;
        
                case NodeType.HEADER_FOOTER:
                    // If the node type is HeaderFooter, we can cast the node to the HeaderFooter class
                    HeaderFooter headerFooter = (HeaderFooter) node;
        
                    // Write the content of the header footer to the console
                    System.out.println("*** HeaderFooter ***");
                    System.out.println(headerFooter.getHeaderFooterType());
                    System.out.println(headerFooter.getText());
                    break;
        
                default:
                    // Other types of nodes never occur inside a Section node
                    throw new Exception("Unexpected node type in a section.");
            }
        }
      • getParagraphs

        public ParagraphCollection getParagraphs()
        
        Gets a collection of paragraphs that are immediate children of the story.

        Example:

        Shows how to get paragraph that was moved (deleted/inserted) in Microsoft Word while change tracking was enabled.
        Document doc = new Document(getMyDir() + "Revisions.docx");
        
        // There are two sets of move revisions in this document
        // One moves a small part of a paragraph, while the other moves a whole paragraph
        // Paragraph.IsMoveFromRevision/IsMoveToRevision will only be true if a whole paragraph is moved, as in the latter case
        ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
        for (int i = 0; i < paragraphs.getCount(); i++) {
            if (paragraphs.get(i).isMoveFromRevision())
                System.out.println(MessageFormat.format("The paragraph {0} has been moved (deleted).", i));
            if (paragraphs.get(i).isMoveToRevision())
                System.out.println(MessageFormat.format("The paragraph {0} has been moved (inserted).", i));
        }
      • 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.
        Document doc = new Document();
        
        // Get the document's first paragraph and append a child node to it in the form of a run with text
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // When inserting a new node, the document that the node will belong to must be provided as an argument
        Run run = new Run(doc, "Hello world!");
        para.appendChild(run);
        
        // The node lineage can be traced back to the document itself
        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.
        // 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));
      • getParentSection

        public Section getParentSection()
        
        Gets the parent section of this story.

        ParentSection is equivalent to (Section)ParentNode.

        Example:

        Shows how to store endnotes at the end of each section instead of the document and manipulate their positions.
        public void suppressEndnotes() throws Exception {
            // Create a new document and make it empty
            Document doc = new Document();
            doc.removeAllChildren();
        
            // Normally endnotes are all stored at the end of a document, but this option lets us store them at the end of each section
            doc.getEndnoteOptions().setPosition(EndnotePosition.END_OF_SECTION);
        
            // Create 3 new sections, each having a paragraph and an endnote at the end
            insertSection(doc, "Section 1", "Endnote 1, will stay in section 1");
            insertSection(doc, "Section 2", "Endnote 2, will be pushed down to section 3");
            insertSection(doc, "Section 3", "Endnote 3, will stay in section 3");
        
            // Each section contains its own page setup object
            // Setting this value will push this section's endnotes down to the next section
            PageSetup pageSetup = doc.getSections().get(1).getPageSetup();
            pageSetup.setSuppressEndnotes(true);
        
            doc.save(getArtifactsDir() + "PageSetup.SuppressEndnotes.docx");
        }
        
        /// <summary>
        /// Add a section to the end of a document, give it a body and a paragraph, then add text and an endnote to that paragraph.
        /// </summary>
        private void insertSection(Document doc, String sectionBodyText, String endnoteText) {
            Section section = new Section(doc);
        
            doc.appendChild(section);
        
            Body body = new Body(doc);
            section.appendChild(body);
        
            Assert.assertEquals(body.getParentNode(), section);
        
            Paragraph para = new Paragraph(doc);
            body.appendChild(para);
        
            Assert.assertEquals(para.getParentNode(), body);
        
            DocumentBuilder builder = new DocumentBuilder(doc);
            builder.moveTo(para);
            builder.write(sectionBodyText);
            builder.insertFootnote(FootnoteType.ENDNOTE, endnoteText);
        }
      • 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);
        
        // Create a second section by inserting a section break and add text to both sections
        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 characters of a range.
        // Insert two sections into a blank document
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.write("Section 1. ");
        builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
        builder.write("Section 2.");
        
        // Verify the whole text of the document
        Assert.assertEquals("Section 1. \fSection 2.", doc.getText().trim());
        
        // 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
        Assert.assertEquals("Section 2.", doc.getText().trim());
      • getStoryType

        public int getStoryType()
        
        Gets the type of this story. The value of the property is StoryType integer constant.

        Example:

        Shows how to clear a body of inline shapes.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Use a DocumentBuilder to insert a shape
        // This is an inline shape, which has a parent Paragraph, which is in turn a child of the Body
        builder.insertShape(ShapeType.CUBE, 100.0, 100.0);
        
        Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 1);
        
        // We can delete all such shapes from the Body, affecting all child Paragraphs
        Assert.assertEquals(doc.getFirstSection().getBody().getStoryType(), StoryType.MAIN_TEXT);
        doc.getFirstSection().getBody().deleteShapes();
        
        Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 0);
      • getTables

        public TableCollection getTables()
        
        Gets a collection of tables that are immediate children of the story.

        Example:

        Shows how to use typed properties to access nodes of the document tree.
        Document doc = new Document(getMyDir() + "Tables.docx");
        
        // Quick typed access to all Table child nodes contained in the Body
        TableCollection tables = doc.getFirstSection().getBody().getTables();
        
        Assert.assertEquals(5, tables.get(0).getRows().getCount());
        Assert.assertEquals(4, tables.get(1).getRows().getCount());
        
        for (Table table : tables) {
            // Quick typed access to the first row of the table
            if (table.getFirstRow() != null) {
                table.getFirstRow().remove();
            }
        
            // Quick typed access to the last row of the table
            if (table.getLastRow() != null) {
                table.getLastRow().remove();
            }
        }
        
        // Each table has shrunk by two rows
        Assert.assertEquals(3, tables.get(0).getRows().getCount());
        Assert.assertEquals(2, tables.get(1).getRows().getCount());
    • Method Detail

      • accept

        public boolean accept(DocumentVisitor visitor)
                      throws java.lang.Exception
        Accepts a visitor.

        Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

        For more info see the Visitor design pattern.

        Calls DocumentVisitor.VisitBodyStart, then calls Accept for all child nodes of the section and calls DocumentVisitor.VisitBodyEnd at the end.
        Parameters:
        visitor - The visitor that will visit the nodes.
        Returns:
        True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

        Example:

        Traverse a document with a visitor that prints all structure nodes that it encounters.
        public void docStructureToText() throws Exception {
            // Open the document that has nodes we want to print the info of
            Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
        
            // Create an object that inherits from the DocumentVisitor class
            DocStructurePrinter visitor = new DocStructurePrinter();
        
            // Accepting a visitor lets it start traversing the nodes in the document,
            // starting with the node that accepted it to then recursively visit every child
            doc.accept(visitor);
        
            // Once the visiting is complete, we can retrieve the result of the operation,
            // that in this example, has accumulated in the visitor
            System.out.println(visitor.getText());
        }
        
        /// <summary>
        /// This Visitor implementation prints information about sections, bodies, paragraphs and runs encountered in the document.
        /// </summary>
        public static class DocStructurePrinter extends DocumentVisitor {
            public DocStructurePrinter() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            /// <summary>
            /// Called when a Document node is encountered.
            /// </summary>
            public int visitDocumentStart(final Document doc) {
                int childNodeCount = doc.getChildNodes(NodeType.ANY, true).getCount();
        
                // A Document node is at the root of every document, so if we let a document accept a visitor, this will be the first visitor action to be carried out
                indentAndAppendLine("[Document start] Child nodes: " + childNodeCount);
                mDocTraversalDepth++;
        
                // Let the visitor continue visiting other nodes
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when the visiting of a Document is ended.
            /// </summary>
            public int visitDocumentEnd(final Document doc) {
                // If we let a document accept a visitor, this will be the last visitor action to be carried out
                mDocTraversalDepth--;
                indentAndAppendLine("[Document end]");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a Section node is encountered in the document.
            /// </summary>
            public int visitSectionStart(final Section section) {
                // Get the index of our section within the document
                NodeCollection docSections = section.getDocument().getChildNodes(NodeType.SECTION, false);
                int sectionIndex = docSections.indexOf(section);
        
                indentAndAppendLine("[Section start] Section index: " + sectionIndex);
                mDocTraversalDepth++;
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when the visiting of a Section node is ended.
            /// </summary>
            public int visitSectionEnd(final Section section) {
                mDocTraversalDepth--;
                indentAndAppendLine("[Section end]");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a Body node is encountered in the document.
            /// </summary>
            public int visitBodyStart(final Body body) {
                int paragraphCount = body.getParagraphs().getCount();
                indentAndAppendLine("[Body start] Paragraphs: " + paragraphCount);
                mDocTraversalDepth++;
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when the visiting of a Body node is ended.
            /// </summary>
            public int visitBodyEnd(final Body body) {
                mDocTraversalDepth--;
                indentAndAppendLine("[Body end]");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a Paragraph node is encountered in the document.
            /// </summary>
            public int visitParagraphStart(final Paragraph paragraph) {
                indentAndAppendLine("[Paragraph start]");
                mDocTraversalDepth++;
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when the visiting of a Paragraph node is ended.
            /// </summary>
            public int visitParagraphEnd(final Paragraph paragraph) {
                mDocTraversalDepth--;
                indentAndAppendLine("[Paragraph end]");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a Run node is encountered in the document.
            /// </summary>
            public int visitRun(final Run run) {
                indentAndAppendLine("[Run] \"" + run.getText() + "\"");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a SubDocument node is encountered in the document.
            /// </summary>
            public int visitSubDocument(final SubDocument subDocument) {
                indentAndAppendLine("[SubDocument]");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Append a line to the StringBuilder and indent it depending on how deep the visitor is into the document tree.
            /// </summary>
            /// <param name="text"></param>
            private void indentAndAppendLine(final String text) {
                for (int i = 0; i < mDocTraversalDepth; i++) {
                    mBuilder.append("|  ");
                }
        
                mBuilder.append(text + "\r\n");
            }
        
            private int mDocTraversalDepth;
            private StringBuilder mBuilder;
        }
      • appendChild

        public Node appendChild(Node newChild)
        Adds the specified node to the end of the list of child nodes for this node.

        If the newChild is already in the tree, it is first removed.

        If the node being inserted was created from another document, you should use DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

        Parameters:
        newChild - The node to add.
        Returns:
        The node added.

        Example:

        Shows how to construct an Aspose Words document node by node.
        Document doc = new Document();
        
        // A newly created blank document still comes one section, one body and one paragraph
        // Calling this method will remove all those nodes to completely empty the document
        doc.removeAllChildren();
        
        // This document now has no composite nodes that content can be added to
        // If we wish to edit it, we will need to repopulate its node collection,
        // which we will start to do with by creating a new Section node
        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);
        
        Assert.assertEquals("Hello World!" + ControlChar.SECTION_BREAK_CHAR, doc.getText());
        
        doc.save(getArtifactsDir() + "Section.CreateFromScratch.docx");
      • appendParagraph

        public Paragraph appendParagraph(java.lang.String text)
        A shortcut method that creates a Paragraph object with optional text and appends it to the end of this object.
        Parameters:
        text - The text for the paragraph. Can be null or empty string.
        Returns:
        The newly created and appended paragraph.

        Example:

        Creates a header and footer using the document object model and insert them into a section.
        Document doc = new Document();
        
        HeaderFooter header = new HeaderFooter(doc, HeaderFooterType.HEADER_PRIMARY);
        doc.getFirstSection().getHeadersFooters().add(header);
        
        // Add a paragraph with text to the footer
        Paragraph para = header.appendParagraph("My header");
        
        Assert.assertTrue(header.isHeader());
        Assert.assertTrue(para.isEndOfHeaderFooter());
        
        HeaderFooter footer = new HeaderFooter(doc, HeaderFooterType.FOOTER_PRIMARY);
        doc.getFirstSection().getHeadersFooters().add(footer);
        
        // Add a paragraph with text to the footer
        para = footer.appendParagraph("My footer");
        
        Assert.assertFalse(footer.isHeader());
        Assert.assertTrue(para.isEndOfHeaderFooter());
        
        Assert.assertEquals(para.getParentStory(), footer);
        Assert.assertEquals(para.getParentSection(), footer.getParentSection());
        Assert.assertEquals(header.getParentSection(), footer.getParentSection());
        
        doc.save(getArtifactsDir() + "HeaderFooter.HeaderFooterCreate.docx");
      • deepClone

        public Node deepClone(boolean isCloneChildren)

        Example:

        Shows how to clone composite nodes with and without their child nodes.
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        para.appendChild(new Run(doc, "Hello world!"));
        
        // Clone the paragraph and the child nodes
        Node cloneWithChildren = para.deepClone(true);
        
        Assert.assertTrue(((CompositeNode) cloneWithChildren).hasChildNodes());
        Assert.assertEquals("Hello world!", cloneWithChildren.getText().trim());
        
        // Clone the paragraph without its clild nodes
        Node cloneWithoutChildren = para.deepClone(false);
        
        Assert.assertFalse(((CompositeNode) cloneWithoutChildren).hasChildNodes());
        Assert.assertEquals("", cloneWithoutChildren.getText().trim());
      • deleteShapes

        public void deleteShapes()
        Deletes all shapes from the text of this story.

        Example:

        Shows how to clear a body of inline shapes.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Use a DocumentBuilder to insert a shape
        // This is an inline shape, which has a parent Paragraph, which is in turn a child of the Body
        builder.insertShape(ShapeType.CUBE, 100.0, 100.0);
        
        Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 1);
        
        // We can delete all such shapes from the Body, affecting all child Paragraphs
        Assert.assertEquals(doc.getFirstSection().getBody().getStoryType(), StoryType.MAIN_TEXT);
        doc.getFirstSection().getBody().deleteShapes();
        
        Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 0);
      • ensureMinimum

        public void ensureMinimum()
        If the last child is not a paragraph, creates and appends one empty paragraph.

        Example:

        Clears main text from all sections from the document leaving the sections themselves.
        // Open a document
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.write("Section 1");
        builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
        builder.write("Section 2");
        
        // This shows what is in the document originally
        // The document has two sections
        Assert.assertEquals(MessageFormat.format("Section 1{0}Section 2{1}", ControlChar.SECTION_BREAK, ControlChar.SECTION_BREAK), doc.getText());
        
        // Loop through all sections in the document
        for (Section section : doc.getSections()) {
            // Each section has a Body node that contains main story (main text) of the section
            Body body = section.getBody();
        
            // This clears all nodes from the body
            body.removeAllChildren();
        
            // Technically speaking, for the main story of a section to be valid, it needs to have
            // at least one empty paragraph. That's what the EnsureMinimum method does
            body.ensureMinimum();
        }
        
        // Check how the content of the document looks now
        Assert.assertEquals(MessageFormat.format("{0}{1}", ControlChar.SECTION_BREAK, ControlChar.SECTION_BREAK), doc.getText());
      • 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() + "Nested tables.docx");
            NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
        
            for (int i = 0; i < tables.getCount(); i++) {
                // First lets find if any cells in the table have tables themselves as children
                int count = getChildTableCount((Table) tables.get(i));
                System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, 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) tables.get(i));
        
                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;
        
            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(table.getNodeType());
        
            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(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 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.

        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() + "Nested tables.docx");
            NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
        
            for (int i = 0; i < tables.getCount(); i++) {
                // First lets find if any cells in the table have tables themselves as children
                int count = getChildTableCount((Table) tables.get(i));
                System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, 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) tables.get(i));
        
                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;
        
            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(table.getNodeType());
        
            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(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 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;
        }
      • getChild

        public Node getChild(int nodeType, int index, boolean isDeep)
        Returns an Nth child node that matches the specified type.

        If index is out of range, a null is returned.

        Note that markup nodes (NodeType.STRUCTURED_DOCUMENT_TAG and NodeType.SMART_TAG) are traversed even when isDeep = false and GetChild is invoked for non-markup node type. For example if the first run in a para is wrapped in a StructuredDocumentTag, it will still be returned by GetChild(NodeType.Run, 0, false).
        Parameters:
        nodeType - A NodeType value. Specifies the type of the child node.
        index - Zero based index of the child node to select. Negative indexes are also allowed and indicate access from the end, that is -1 means the last node.
        isDeep - True to select from all child nodes recursively. False to select only among immediate children. See remarks for more info.
        Returns:
        The child node that matches the criteria or null if no matching node is found.

        Example:

        Shows how to expand the formatting from styles onto the rows and cells of the table as direct formatting.
        Document doc = new Document(getMyDir() + "Tables.docx");
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        // First print the color of the cell shading. This should be empty as the current shading
        // is stored in the table style
        double cellShadingBefore = table.getFirstRow().getRowFormat().getHeight();
        System.out.println("Cell shading before style expansion: " + cellShadingBefore);
        
        // Expand table style formatting to direct formatting
        doc.expandTableStylesToDirectFormatting();
        
        // Now print the cell shading after expanding table styles. A blue background pattern color
        // should have been applied from the table style
        double cellShadingAfter = table.getFirstRow().getRowFormat().getHeight();
        System.out.println("Cell shading after style expansion: " + cellShadingAfter);
        
        doc.save(getArtifactsDir() + "Document.TableStyleToDirectFormatting.docx");

        Example:

        Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.
        Document doc = new Document();
        
        Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
        paragraph.appendChild(new Run(doc, "Hello world!"));
        paragraph.appendChild(new Run(doc, " Hello again!"));
        
        NodeCollection children = paragraph.getChildNodes();
        
        // Paragraph may contain children of various types such as runs, shapes and so on
        for (Node child : (Iterable<Node>) children)
            if (((child.getNodeType()) == (NodeType.RUN))) {
                Run run = (Run) child;
                System.out.println(run.getText());
            }
      • getChildNodes

        public NodeCollection getChildNodes(int nodeType, boolean isDeep)
        Returns a live collection of child nodes that match the specified type.

        The collection of nodes returned by this method is always live.

        A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.

        Parameters:
        nodeType - A NodeType value. Specifies the type of nodes to select.
        isDeep - True to select from all child nodes recursively. False to select only among immediate children.
        Returns:
        A live collection of child nodes of the specified type.

        Example:

        Shows how to get all comments with all replies.
        Document doc = new Document(getMyDir() + "Comments.docx");
        
        // Get all comment from the document
        NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
        
        // For all comments and replies we identify comment level and info about it
        for (Comment comment : (Iterable<Comment>) comments) {
            if (comment.getAncestor() == null) {
                System.out.println("\nThis is a top-level comment");
                System.out.println("Comment author: " + comment.getAuthor());
                System.out.println("Comment text: " + comment.getText());
        
                for (Comment commentReply : comment.getReplies()) {
                    System.out.println("\n\tThis is a comment reply");
                    System.out.println("\tReply author: " + commentReply.getAuthor());
                    System.out.println("\tReply text: " + commentReply.getText());
                }
            }
        }

        Example:

        Shows how to extract images from a document and save them as files.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
        
        int imageIndex = 0;
        for (Shape shape : (Iterable<Shape>) shapes) {
            if (shape.hasImage()) {
                String imageFileName = MessageFormat.format("File.ExtractImagesToFiles.{0}{1}", imageIndex,
                        FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
                shape.getImageData().save(getArtifactsDir() + imageFileName);
                imageIndex++;
            }
        }
        
        Assert.assertEquals(9, imageIndex);
      • getText

        public java.lang.String getText()
        Gets the text of this node and of all its children.

        The returned string includes all control and special characters as described in ControlChar.

        Example:

        Shows how to output all paragraphs in a document that are bulleted or numbered.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getListFormat().applyNumberDefault();
        builder.writeln("Numbered list item 1");
        builder.writeln("Numbered list item 2");
        builder.writeln("Numbered list item 3");
        builder.getListFormat().removeNumbers();
        
        builder.getListFormat().applyBulletDefault();
        builder.writeln("Bulleted list item 1");
        builder.writeln("Bulleted list item 2");
        builder.writeln("Bulleted list item 3");
        builder.getListFormat().removeNumbers();
        
        NodeCollection paras = doc.getChildNodes(NodeType.PARAGRAPH, true);
        for (Paragraph para : (Iterable<Paragraph>) paras) {
            if (para.getListFormat().isListItem()) {
                System.out.println(java.text.MessageFormat.format("*** A paragraph belongs to list {0}", para.getListFormat().getList().getListId()));
                System.out.println(para.getText());
            }
        }

        Example:

        Shows the difference between calling the GetText and ToString methods on a node.
        Document doc = new Document();
        
        // Enter a field into the document
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertField("MERGEFIELD Field");
        
        // GetText will retrieve all field codes and special characters
        Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());
        
        // ToString will give us the plaintext version of the document in the save format we put into the parameter
        Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));
      • indexOf

        public int indexOf(Node child)
        Returns the index of the specified child node in the child node array. Returns -1 if the node is not found in the child nodes.

        Example:

        Shows how to get the index of a given child node from its parent.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // Get the body of the first section in the document
        Body body = doc.getFirstSection().getBody();
        
        // Retrieve the index of the last paragraph in the body
        Assert.assertEquals(24, body.getChildNodes().indexOf(body.getLastParagraph()));
      • insertAfter

        public Node insertAfter(Node newChild, Node refChild)
        Inserts the specified node immediately after the specified reference node.

        If refChild is null, inserts newChild at the beginning of the list of child nodes.

        If the newChild is already in the tree, it is first removed.

        If the node being inserted was created from another document, you should use DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

        Parameters:
        newChild - The Node to insert.
        refChild - The Node that is the reference node. The newNode is placed after the refNode.
        Returns:
        The inserted node.

        Example:

        Shows how to replace all textboxes with images.
        Document doc = new Document(getMyDir() + "Textboxes in drawing canvas.docx");
        
        // This gets a live collection of all shape nodes in the document
        NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);
        
        // Since we will be adding/removing nodes, it is better to copy all collection
        // into a fixed size array, otherwise iterator will be invalidated
        Node[] shapes = shapeCollection.toArray();
        
        for (Node node : shapes) {
            Shape shape = (Shape) node;
            // Filter out all shapes that we don't need
            if (shape.getShapeType() == ShapeType.TEXT_BOX) {
                // Create a new shape that will replace the existing shape
                Shape image = new Shape(doc, ShapeType.IMAGE);
        
                // Load the image into the new shape
                image.getImageData().setImage(getImageDir() + "Windows MetaFile.wmf");
        
                // Make new shape's position to match the old shape
                image.setLeft(shape.getLeft());
                image.setTop(shape.getTop());
                image.setWidth(shape.getWidth());
                image.setHeight(shape.getHeight());
                image.setRelativeHorizontalPosition(shape.getRelativeHorizontalPosition());
                image.setRelativeVerticalPosition(shape.getRelativeVerticalPosition());
                image.setHorizontalAlignment(shape.getHorizontalAlignment());
                image.setVerticalAlignment(shape.getVerticalAlignment());
                image.setWrapType(shape.getWrapType());
                image.setWrapSide(shape.getWrapSide());
        
                // Insert new shape after the old shape and remove the old shape
                shape.getParentNode().insertAfter(image, shape);
                shape.remove();
            }
        }
        
        doc.save(getArtifactsDir() + "Shape.ReplaceTextboxesWithImages.docx");

        Example:

        Shows how to add, update and delete child nodes from a CompositeNode's child collection.
        Document doc = new Document();
        
        // An empty document has one paragraph by default
        Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
        
        // A paragraph is a composite node because it can contain runs, which are another type of node
        Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
        Run paragraphText = new Run(doc, "Initial text. ");
        paragraph.appendChild(paragraphText);
        
        // We will place these 3 children into the main text of our paragraph
        Run run1 = new Run(doc, "Run 1. ");
        Run run2 = new Run(doc, "Run 2. ");
        Run run3 = new Run(doc, "Run 3. ");
        
        // We initialized them but not in our paragraph yet
        Assert.assertEquals("Initial text.", paragraph.getText().trim());
        
        // Insert run2 before initial paragraph text. This will be at the start of the paragraph
        paragraph.insertBefore(run2, paragraphText);
        
        // Insert run3 after initial paragraph text. This will be at the end of the paragraph
        paragraph.insertAfter(run3, paragraphText);
        
        // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1
        paragraph.prependChild(run1);
        
        Assert.assertEquals("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim());
        Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount());
        
        // Access the child node collection and update/delete children
        ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
        paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);
        
        Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
        Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());
      • insertBefore

        public Node insertBefore(Node newChild, Node refChild)
        Inserts the specified node immediately before the specified reference node.

        If refChild is null, inserts newChild at the end of the list of child nodes.

        If the newChild is already in the tree, it is first removed.

        If the node being inserted was created from another document, you should use DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

        Parameters:
        newChild - The Node to insert.
        refChild - The Node that is the reference node. The newChild is placed before this node.
        Returns:
        The inserted node.

        Example:

        Shows how to add, update and delete child nodes from a CompositeNode's child collection.
        Document doc = new Document();
        
        // An empty document has one paragraph by default
        Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
        
        // A paragraph is a composite node because it can contain runs, which are another type of node
        Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
        Run paragraphText = new Run(doc, "Initial text. ");
        paragraph.appendChild(paragraphText);
        
        // We will place these 3 children into the main text of our paragraph
        Run run1 = new Run(doc, "Run 1. ");
        Run run2 = new Run(doc, "Run 2. ");
        Run run3 = new Run(doc, "Run 3. ");
        
        // We initialized them but not in our paragraph yet
        Assert.assertEquals("Initial text.", paragraph.getText().trim());
        
        // Insert run2 before initial paragraph text. This will be at the start of the paragraph
        paragraph.insertBefore(run2, paragraphText);
        
        // Insert run3 after initial paragraph text. This will be at the end of the paragraph
        paragraph.insertAfter(run3, paragraphText);
        
        // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1
        paragraph.prependChild(run1);
        
        Assert.assertEquals("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim());
        Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount());
        
        // Access the child node collection and update/delete children
        ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
        paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);
        
        Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
        Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());
      • iterator

        public java.util.Iterator<Node> iterator()
        Provides support for the for each style iteration over the child nodes of this node.

        Example:

        Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.
        Document doc = new Document();
        
        Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
        paragraph.appendChild(new Run(doc, "Hello world!"));
        paragraph.appendChild(new Run(doc, " Hello again!"));
        
        NodeCollection children = paragraph.getChildNodes();
        
        // Paragraph may contain children of various types such as runs, shapes and so on
        for (Node child : (Iterable<Node>) children)
            if (((child.getNodeType()) == (NodeType.RUN))) {
                Run run = (Run) child;
                System.out.println(run.getText());
            }
      • 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.
        Document doc = new Document(getMyDir() + "Images.docx");
        Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10);
        
        Node curNode = doc;
        while (curNode != null) {
            Node nextNode = curNode.nextPreOrder(doc);
        
            if (curNode.previousPreOrder(doc) != null && nextNode != null) {
                Assert.assertEquals(curNode, nextNode.previousPreOrder(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;
        }
        
        // The only remaining shape doesn't have an image
        Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
        Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());
      • prependChild

        public Node prependChild(Node newChild)
        Adds the specified node to the beginning of the list of child nodes for this node.

        If the newChild is already in the tree, it is first removed.

        If the node being inserted was created from another document, you should use DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

        Parameters:
        newChild - The node to add.
        Returns:
        The node added.

        Example:

        Shows how to add, update and delete child nodes from a CompositeNode's child collection.
        Document doc = new Document();
        
        // An empty document has one paragraph by default
        Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
        
        // A paragraph is a composite node because it can contain runs, which are another type of node
        Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
        Run paragraphText = new Run(doc, "Initial text. ");
        paragraph.appendChild(paragraphText);
        
        // We will place these 3 children into the main text of our paragraph
        Run run1 = new Run(doc, "Run 1. ");
        Run run2 = new Run(doc, "Run 2. ");
        Run run3 = new Run(doc, "Run 3. ");
        
        // We initialized them but not in our paragraph yet
        Assert.assertEquals("Initial text.", paragraph.getText().trim());
        
        // Insert run2 before initial paragraph text. This will be at the start of the paragraph
        paragraph.insertBefore(run2, paragraphText);
        
        // Insert run3 after initial paragraph text. This will be at the end of the paragraph
        paragraph.insertAfter(run3, paragraphText);
        
        // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1
        paragraph.prependChild(run1);
        
        Assert.assertEquals("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim());
        Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount());
        
        // Access the child node collection and update/delete children
        ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
        paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);
        
        Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
        Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());
      • 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.

        Example:

        Shows how to delete all images from a document using pre-order tree traversal.
        Document doc = new Document(getMyDir() + "Images.docx");
        Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10);
        
        Node curNode = doc;
        while (curNode != null) {
            Node nextNode = curNode.nextPreOrder(doc);
        
            if (curNode.previousPreOrder(doc) != null && nextNode != null) {
                Assert.assertEquals(curNode, nextNode.previousPreOrder(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;
        }
        
        // The only remaining shape doesn't have an image
        Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
        Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());
      • remove

        public void remove()
        Removes itself from the parent.

        Example:

        Shows how to delete all images from a document.
        Document doc = new Document(getMyDir() + "Images.docx");
        Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10);
        
        // 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();
        
        // The only remaining shape doesn't have an image
        Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
        Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());

        Example:

        Shows how to remove all 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());
        
        // Select the first child node in the body
        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();
            }
        
            // Continue going through child nodes until null (no more siblings) is reached
            curNode = nextNode;
        }
        
        Assert.assertEquals(0, doc.getChildNodes(NodeType.TABLE, true).getCount());
      • removeAllChildren

        public void removeAllChildren()
        Removes all the child nodes of the current node.

        Example:

        Shows how to construct an Aspose Words document node by node.
        Document doc = new Document();
        
        // A newly created blank document still comes one section, one body and one paragraph
        // Calling this method will remove all those nodes to completely empty the document
        doc.removeAllChildren();
        
        // This document now has no composite nodes that content can be added to
        // If we wish to edit it, we will need to repopulate its node collection,
        // which we will start to do with by creating a new Section node
        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);
        
        Assert.assertEquals("Hello World!" + ControlChar.SECTION_BREAK_CHAR, doc.getText());
        
        doc.save(getArtifactsDir() + "Section.CreateFromScratch.docx");
      • removeChild

        public Node removeChild(Node oldChild)
        Removes the specified child node.

        The parent of oldChild is set to null after the node is removed.

        Parameters:
        oldChild - The node to remove.
        Returns:
        The removed node.

        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);
        
        // Create a second section by inserting a section break and add text to both sections
        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());
      • removeSmartTags

        public void removeSmartTags()
        Removes all SmartTag descendant nodes of the current node. This method does not remove the content of the smart tags.

        Example:

        Removes all smart tags from descendant nodes of the composite node.
        Document doc = new Document(getMyDir() + "Smart tags.doc");
        Assert.assertEquals(8, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
        
        // Remove smart tags from the whole document
        doc.removeSmartTags();
        
        Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
      • selectNodes

        public NodeList selectNodes(java.lang.String xpath)
        Selects a list of nodes matching the XPath expression.

        Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

        Parameters:
        xpath - The XPath expression.
        Returns:
        A list of nodes matching the XPath query.

        Example:

        Shows how to select certain nodes by using an XPath expression.
        Document doc = new Document(getMyDir() + "Tables.docx");
        
        // This expression will extract all paragraph nodes which are descendants of any table node in the document
        // This will return any paragraphs which are in a table
        NodeList nodeList = doc.selectNodes("//Table//Paragraph");
        
        // Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table
        int index = 0;
        
        Iterator<Node> e = nodeList.iterator();
        while (e.hasNext()) {
            Node currentNode = e.next();
            System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim()));
        }
        
        // This expression will select any paragraphs that are direct children of any body node in the document
        nodeList = doc.selectNodes("//Body/Paragraph");
        
        // We can treat the list as an array too
        Assert.assertEquals(nodeList.toArray().length, 4);
        
        // Use SelectSingleNode to select the first result of the same expression as above
        Node node = doc.selectSingleNode("//Body/Paragraph");
        
        Assert.assertEquals(Paragraph.class, node.getClass());

        Example:

        Shows how to test if a node is inside a field by using an XPath expression.
        Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx");
        
        // Evaluate the XPath expression. The resulting NodeList will contain all nodes found inside a field a field (between FieldStart 
        // and FieldEnd exclusive). There can however be FieldStart and FieldEnd nodes in the list if there are nested fields 
        // in the path. Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs
        NodeList resultList =
                doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]");
        
        // Check if the specified run is one of the nodes that are inside the field
        System.out.println("Contents of the first Run node that's part of a field: {resultList.First(n => n.NodeType == NodeType.Run).GetText().Trim()}");
      • selectSingleNode

        public Node selectSingleNode(java.lang.String xpath)
        Selects the first Node that matches the XPath expression.

        Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

        Parameters:
        xpath - The XPath expression.
        Returns:
        The first Node that matches the XPath query or null if no matching node is found.

        Example:

        Shows how to select certain nodes by using an XPath expression.
        Document doc = new Document(getMyDir() + "Tables.docx");
        
        // This expression will extract all paragraph nodes which are descendants of any table node in the document
        // This will return any paragraphs which are in a table
        NodeList nodeList = doc.selectNodes("//Table//Paragraph");
        
        // Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table
        int index = 0;
        
        Iterator<Node> e = nodeList.iterator();
        while (e.hasNext()) {
            Node currentNode = e.next();
            System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim()));
        }
        
        // This expression will select any paragraphs that are direct children of any body node in the document
        nodeList = doc.selectNodes("//Body/Paragraph");
        
        // We can treat the list as an array too
        Assert.assertEquals(nodeList.toArray().length, 4);
        
        // Use SelectSingleNode to select the first result of the same expression as above
        Node node = doc.selectSingleNode("//Body/Paragraph");
        
        Assert.assertEquals(Paragraph.class, node.getClass());
      • 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");
        
        // Extract the last paragraph in the document to convert to HTML
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When ToString is called using the html SaveFormat overload then the node is converted directly to html
        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 label of each paragraph in a list as a value or a String.
        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 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("\tNumerical Id: " + label.getLabelValue());
        
                // Combine them together to include the list label with the text in the output
                System.out.println("\tList label combined with text: " + label.getLabelString() + " " + paragraphText);
        
                listParaCount++;
            }
        }

        Example:

        Exports the content of a node to String in HTML format.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        // Extract the last paragraph in the document to convert to HTML
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When ToString is called using the html SaveFormat overload then the node is converted directly to html
        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();
        
        // Enter a field into the document
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertField("MERGEFIELD Field");
        
        // GetText will retrieve all field codes and special characters
        Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());
        
        // ToString will give us the plaintext version of the document in the save format we put into the parameter
        Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));