com.aspose.words

Class Paragraph

  • All Implemented Interfaces:
    java.lang.Iterable, java.lang.Cloneable
    public class Paragraph 
    extends CompositeNode

Represents a paragraph of text.

Paragraph is a block-level node and can be a child of classes derived from Story or InlineStory.

Paragraph can contain any number of inline-level nodes and bookmarks.

The complete list of child nodes that can occur inside a paragraph consists of BookmarkStart, BookmarkEnd, FieldStart, FieldSeparator, FieldEnd, FormField, Comment, Footnote, Run, SpecialChar, Shape, GroupShape, SmartTag.

A valid paragraph in Microsoft Word always ends with a paragraph break character and a minimal valid paragraph consists just of a paragraph break. The Paragraph class automatically appends the appropriate paragraph break character at the end and this character is not part of the child nodes of the Paragraph, therefore a Paragraph can be empty.

Do not include the end of paragraph ControlChar.PARAGRAPH_BREAK or end of cell ControlChar.CELL characters inside the text of the paragraph as it might make the paragraph invalid when the document is opened in Microsoft Word.

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
Paragraph(DocumentBase doc)
Initializes a new instance of the Paragraph class.
 
Property Getters/Setters Summary
booleangetBreakIsStyleSeparator()
True if this paragraph break is a Style Separator. A style separator allows one paragraph to consist of parts that have different paragraph styles.
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.
FrameFormatgetFrameFormat()
Provides access to the paragraph formatting properties.
booleanhasChildNodes()
Returns true if this node has any child nodes.
booleanisComposite()
Returns true as this node can have child nodes.
booleanisDeleteRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisEndOfCell()
True if this paragraph is the last paragraph in a Cell; false otherwise.
booleanisEndOfDocument()
True if this paragraph is the last paragraph in the last section of the document.
booleanisEndOfHeaderFooter()
True if this paragraph is the last paragraph in the HeaderFooter (main text story) of a Section; false otherwise.
booleanisEndOfSection()
True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise.
booleanisFormatRevision()
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
booleanisInCell()
True if this paragraph is an immediate child of Cell; false otherwise.
booleanisInsertRevision()
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
booleanisListItem()
True when the paragraph is an item in a bulleted or numbered list in original revision.
booleanisMoveFromRevision()
Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
booleanisMoveToRevision()
Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
NodegetLastChild()
Gets the last child of the node.
ListFormatgetListFormat()
Provides access to the list formatting properties of the paragraph.
ListLabelgetListLabel()
Gets a ListLabel object that provides access to list numbering value and formatting for this paragraph.
NodegetNextSibling()
Gets the node immediately following this node.
intgetNodeType()
Returns NodeType.Paragraph. The value of the property is NodeType integer constant.
FontgetParagraphBreakFont()
Provides access to the font formatting of the paragraph break character.
ParagraphFormatgetParagraphFormat()
Provides access to the paragraph formatting properties.
CompositeNodegetParentNode()
Gets the immediate parent of this node.
SectiongetParentSection()
Retrieves the parent Section of the paragraph.
StorygetParentStory()
Retrieves the parent section-level story that can be Body or HeaderFooter.
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.
RunCollectiongetRuns()
Provides access to the typed collection of pieces of text inside the paragraph.
 
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.
FieldappendField(int fieldType, boolean updateField)
Appends a field to this paragraph.
FieldappendField(java.lang.String fieldCode)
Appends a field to this paragraph.
FieldappendField(java.lang.String fieldCode, java.lang.String fieldValue)
Appends a field to this paragraph.
NodedeepClone(boolean isCloneChildren)
CompositeNodegetAncestor(int ancestorType)
Gets the first ancestor of the specified NodeType.
CompositeNodegetAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.
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.
TabStop[]getEffectiveTabStops()
Returns array of all tab stops applied to this paragraph, including applied indirectly by styles or lists.
java.lang.StringgetText()
Gets the text of this paragraph including the end of paragraph character.
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.
FieldinsertField(int fieldType, boolean updateField, Node refNode, boolean isAfter)
Inserts a field into this paragraph.
FieldinsertField(java.lang.String fieldCode, Node refNode, boolean isAfter)
Inserts a field into this paragraph.
FieldinsertField(java.lang.String fieldCode, java.lang.String fieldValue, Node refNode, boolean isAfter)
Inserts a field into this paragraph.
java.util.Iterator<Node>iterator()
Provides support for the for each style iteration over the child nodes of this node.
intjoinRunsWithSameFormatting()
Joins runs with the same formatting in the paragraph.
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

      • Paragraph

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

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

        To append Paragraph to the document use InsertAfter or InsertBefore on the story where you want the paragraph inserted.

        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

      • getBreakIsStyleSeparator

        public boolean getBreakIsStyleSeparator()
        
        True if this paragraph break is a Style Separator. A style separator allows one paragraph to consist of parts that have different paragraph styles.

        Example:

        Shows how to write text to the same line as a TOC heading and have it not show up in the TOC.
        // Create a blank document and insert a table of contents field
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertTableOfContents("\\o \\h \\z \\u");
        builder.insertBreak(BreakType.PAGE_BREAK);
        
        // Insert a paragraph with a style that will be picked up as an entry in the TOC
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
        
        // Both these strings are on the same line and same paragraph and will therefore show up on the same TOC entry
        builder.write("Heading 1. ");
        builder.write("Will appear in the TOC. ");
        
        // Any text on a new line that does not have a heading style will not register as a TOC entry
        // If we insert a style separator, we can write more text on the same line
        // and use a different style without it showing up in the TOC
        // If we use a heading type style afterwards, we can draw two TOC entries from one line of document text
        builder.insertStyleSeparator();
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.QUOTE);
        builder.write("Won't appear in the TOC. ");
        
        // This flag is set to true for such paragraphs
        Assert.assertTrue(doc.getFirstSection().getBody().getParagraphs().get(0).getBreakIsStyleSeparator());
        
        // Update the TOC and save the document
        doc.updateFields();
        doc.save(getArtifactsDir() + "Paragraph.BreakIsStyleSeparator.docx");
      • 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();
                }
            }
        }
      • getFrameFormat

        public FrameFormat getFrameFormat()
        
        Provides access to the paragraph formatting properties.

        Example:

        Shows how to get information about formatting properties of paragraphs that are frames.
        Document doc = new Document(getMyDir() + "Paragraph frame.docx");
        
        ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
        
        for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs) {
            if (paragraph.getFrameFormat().isFrame()) {
                System.out.println("Width: " + paragraph.getFrameFormat().getWidth());
                System.out.println("Height: " + paragraph.getFrameFormat().getHeight());
                System.out.println("HeightRule: " + paragraph.getFrameFormat().getHeightRule());
                System.out.println("HorizontalAlignment: " + paragraph.getFrameFormat().getHorizontalAlignment());
                System.out.println("VerticalAlignment: " + paragraph.getFrameFormat().getVerticalAlignment());
                System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition());
                System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition());
                System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText());
                System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition());
                System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition());
                System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText());
            }
        }
      • 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.doc");
      • 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();
                }
            }
        }
      • isDeleteRevision

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

        Example:

        Shows how to work with revision paragraphs.
        Document doc = new Document();
        Body body = doc.getFirstSection().getBody();
        Paragraph para = body.getFirstParagraph();
        
        // Add text to the first paragraph, then add two more paragraphs
        para.appendChild(new Run(doc, "Paragraph 1. "));
        body.appendParagraph("Paragraph 2. ");
        body.appendParagraph("Paragraph 3. ");
        
        // We have three paragraphs, none of which registered as any type of revision
        // If we add/remove any content in the document while tracking revisions,
        // they will be displayed as such in the document and can be accepted/rejected
        doc.startTrackRevisions("John Doe", new Date());
        
        // This paragraph is a revision and will have the according "IsInsertRevision" flag set
        para = body.appendParagraph("Paragraph 4. ");
        Assert.assertTrue(para.isInsertRevision());
        
        // Get the document's paragraph collection and remove a paragraph
        ParagraphCollection paragraphs = body.getParagraphs();
        Assert.assertEquals(paragraphs.getCount(), 4);
        para = paragraphs.get(2);
        para.remove();
        
        // Since we are tracking revisions, the paragraph still exists in the document, will have the "IsDeleteRevision" set
        // and will be displayed as a revision in Microsoft Word, until we accept or reject all revisions
        Assert.assertEquals(paragraphs.getCount(), 4);
        Assert.assertTrue(para.isDeleteRevision());
        
        // The delete revision paragraph is removed once we accept changes
        doc.acceptAllRevisions();
        Assert.assertEquals(paragraphs.getCount(), 3);
        Assert.assertEquals(para.getCount(), 0);
      • isEndOfCell

        public boolean isEndOfCell()
        
        True if this paragraph is the last paragraph in a Cell; false otherwise.

        Example:

        Shows how to set a table to stay together on the same page.
        // To keep a table from breaking across a page we need to enable KeepWithNext
        // for every paragraph in the table except for the last paragraphs in the last
        // row of the table
        for (Cell cell : (Iterable<Cell>) table.getChildNodes(NodeType.CELL, true)) {
            for (Paragraph para : cell.getParagraphs()) {
                // Every paragraph that's inside a cell will have this flag set
                Assert.assertTrue(para.isInCell());
        
                if (!(cell.getParentRow().isLastRow() && para.isEndOfCell())) {
                    para.getParagraphFormat().setKeepWithNext(true);
                }
            }
        }
      • isEndOfDocument

        public boolean isEndOfDocument()
        
        True if this paragraph is the last paragraph in the last section of the document.
      • isEndOfHeaderFooter

        public boolean isEndOfHeaderFooter()
        
        True if this paragraph is the last paragraph in the HeaderFooter (main text story) of a Section; false otherwise.

        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");
      • isEndOfSection

        public boolean isEndOfSection()
        
        True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise.

        Example:

        Shows how to insert the contents of one document to a bookmark in another document.
        @Test
        public void insertAtBookmark() throws Exception {
            Document mainDoc = new Document(getMyDir() + "Document insertion destination.docx");
            Document docToInsert = new Document(getMyDir() + "Document.docx");
        
            Bookmark bookmark = mainDoc.getRange().getBookmarks().get("insertionPlace");
            insertDocument(bookmark.getBookmarkStart().getParentNode(), docToInsert);
        
            mainDoc.save(getArtifactsDir() + "InsertDocument.InsertAtBookmark.docx");
        }
        
        /// <summary>
        /// Inserts content of the external document after the specified node.
        /// </summary>
        static void insertDocument(Node insertionDestination, Document docToInsert) {
            // Make sure that the node is either a paragraph or table
            if (((insertionDestination.getNodeType()) == (NodeType.PARAGRAPH)) || ((insertionDestination.getNodeType()) == (NodeType.TABLE))) {
                // We will be inserting into the parent of the destination paragraph
                CompositeNode dstStory = insertionDestination.getParentNode();
        
                // This object will be translating styles and lists during the import
                NodeImporter importer =
                        new NodeImporter(docToInsert, insertionDestination.getDocument(), ImportFormatMode.KEEP_SOURCE_FORMATTING);
        
                // Loop through all block level nodes in the body of the section
                for (Section srcSection : docToInsert.getSections())
                    for (Node srcNode : srcSection.getBody()) {
                        // Let's skip the node if it is a last empty paragraph in a section
                        if (((srcNode.getNodeType()) == (NodeType.PARAGRAPH))) {
                            Paragraph para = (Paragraph) srcNode;
                            if (para.isEndOfSection() && !para.hasChildNodes())
                                continue;
                        }
        
                        // This creates a clone of the node, suitable for insertion into the destination document
                        Node newNode = importer.importNode(srcNode, true);
        
                        // Insert new node after the reference node
                        dstStory.insertAfter(newNode, insertionDestination);
                        insertionDestination = newNode;
                    }
            } else {
                throw new IllegalArgumentException("The destination node should be either a paragraph or table.");
            }
        }
      • isFormatRevision

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

        Example:

        Shows how to get information about whether this object was formatted in Microsoft Word while change tracking was enabled.
        Document doc = new Document(getMyDir() + "Format revision.docx");
        
        // This paragraph's formatting was changed while revisions were being tracked
        Assert.assertTrue(doc.getFirstSection().getBody().getFirstParagraph().isFormatRevision());
      • isInCell

        public boolean isInCell()
        
        True if this paragraph is an immediate child of Cell; false otherwise.

        Example:

        Shows how to set a table to stay together on the same page.
        // To keep a table from breaking across a page we need to enable KeepWithNext
        // for every paragraph in the table except for the last paragraphs in the last
        // row of the table
        for (Cell cell : (Iterable<Cell>) table.getChildNodes(NodeType.CELL, true)) {
            for (Paragraph para : cell.getParagraphs()) {
                // Every paragraph that's inside a cell will have this flag set
                Assert.assertTrue(para.isInCell());
        
                if (!(cell.getParentRow().isLastRow() && para.isEndOfCell())) {
                    para.getParagraphFormat().setKeepWithNext(true);
                }
            }
        }
      • isInsertRevision

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

        Example:

        Shows how to work with revision paragraphs.
        Document doc = new Document();
        Body body = doc.getFirstSection().getBody();
        Paragraph para = body.getFirstParagraph();
        
        // Add text to the first paragraph, then add two more paragraphs
        para.appendChild(new Run(doc, "Paragraph 1. "));
        body.appendParagraph("Paragraph 2. ");
        body.appendParagraph("Paragraph 3. ");
        
        // We have three paragraphs, none of which registered as any type of revision
        // If we add/remove any content in the document while tracking revisions,
        // they will be displayed as such in the document and can be accepted/rejected
        doc.startTrackRevisions("John Doe", new Date());
        
        // This paragraph is a revision and will have the according "IsInsertRevision" flag set
        para = body.appendParagraph("Paragraph 4. ");
        Assert.assertTrue(para.isInsertRevision());
        
        // Get the document's paragraph collection and remove a paragraph
        ParagraphCollection paragraphs = body.getParagraphs();
        Assert.assertEquals(paragraphs.getCount(), 4);
        para = paragraphs.get(2);
        para.remove();
        
        // Since we are tracking revisions, the paragraph still exists in the document, will have the "IsDeleteRevision" set
        // and will be displayed as a revision in Microsoft Word, until we accept or reject all revisions
        Assert.assertEquals(paragraphs.getCount(), 4);
        Assert.assertTrue(para.isDeleteRevision());
        
        // The delete revision paragraph is removed once we accept changes
        doc.acceptAllRevisions();
        Assert.assertEquals(paragraphs.getCount(), 3);
        Assert.assertEquals(para.getCount(), 0);
      • isListItem

        public boolean isListItem()
        
        True when the paragraph is an item in a bulleted or numbered list in original revision.

        Example:

        Shows how to start a numbered list, add a bulleted list inside it, then return to the numbered list.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create an outline list for the headings
        List outlineList = doc.getLists().add(ListTemplate.OUTLINE_NUMBERS);
        builder.getListFormat().setList(outlineList);
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
        builder.writeln("This is my Chapter 1");
        
        // Create a numbered list
        List numberedList = doc.getLists().add(ListTemplate.NUMBER_DEFAULT);
        builder.getListFormat().setList(numberedList);
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.NORMAL);
        builder.writeln("Numbered list item 1.");
        
        // Every paragraph that comprises a list will have this flag
        Assert.assertTrue(builder.getCurrentParagraph().isListItem());
        Assert.assertTrue(builder.getParagraphFormat().isListItem());
        
        // Create a bulleted list
        List bulletedList = doc.getLists().add(ListTemplate.BULLET_DEFAULT);
        builder.getListFormat().setList(bulletedList);
        builder.getParagraphFormat().setLeftIndent(72.0);
        builder.writeln("Bulleted list item 1.");
        builder.writeln("Bulleted list item 2.");
        builder.getParagraphFormat().clearFormatting();
        
        // Revert to the numbered list
        builder.getListFormat().setList(numberedList);
        builder.writeln("Numbered list item 2.");
        builder.writeln("Numbered list item 3.");
        
        // Revert to the outline list
        builder.getListFormat().setList(outlineList);
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
        builder.writeln("This is my Chapter 2");
        
        builder.getParagraphFormat().clearFormatting();
        
        builder.getDocument().save(getArtifactsDir() + "Lists.NestedLists.docx");
      • isMoveFromRevision

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

        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));
        }
      • isMoveToRevision

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

        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));
        }
      • 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());
      • getListFormat

        public ListFormat getListFormat()
        
        Provides access to the list formatting properties of the paragraph.

        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());
            }
        }
      • getListLabel

        public ListLabel getListLabel()
        
        Gets a ListLabel object that provides access to list numbering value and formatting for this paragraph.

        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++;
            }
        }
      • 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.Paragraph. The value of the property is NodeType integer constant.

        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();
                }
            }
        }
      • getParagraphBreakFont

        public Font getParagraphBreakFont()
        
        Provides access to the font formatting of the paragraph break character.

        Example:

        Implements the Visitor Pattern to remove all content formatted as hidden from the document.
        public void removeHiddenContentFromDocument() throws Exception {
            // Open the document we want to remove hidden content from
            Document doc = new Document(getMyDir() + "Hidden content.docx");
        
            // Create an object that inherits from the DocumentVisitor class
            RemoveHiddenContentVisitor hiddenContentRemover = new RemoveHiddenContentVisitor();
        
            // This is the well known Visitor pattern. Get the model to accept a visitor
            // The model will iterate through itself by calling the corresponding methods
            // on the visitor object (this is called visiting)
        
            // We can run it over the entire the document like so
            doc.accept(hiddenContentRemover);
        
            // Or we can run it on only a specific node
            Paragraph para = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 4, true);
            para.accept(hiddenContentRemover);
        
            // Or over a different type of node like below
            Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
            table.accept(hiddenContentRemover);
        
            doc.save(getArtifactsDir() + "Font.RemoveHiddenContentFromDocument.docx");
        }
        
        /**
         * This class when executed will remove all hidden content from the Document. Implemented as a Visitor.
         */
        private class RemoveHiddenContentVisitor extends DocumentVisitor {
            /**
             * Called when a FieldStart node is encountered in the document.
             */
            public int visitFieldStart(final FieldStart fieldStart) throws Exception {
                // If this node is hidden, then remove it
                if (fieldStart.getFont().getHidden()) {
                    fieldStart.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a FieldEnd node is encountered in the document.
             */
            public int visitFieldEnd(final FieldEnd fieldEnd) throws Exception {
                if (fieldEnd.getFont().getHidden()) {
                    fieldEnd.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a FieldSeparator node is encountered in the document.
             */
            public int visitFieldSeparator(final FieldSeparator fieldSeparator) throws Exception {
                if (fieldSeparator.getFont().getHidden()) {
                    fieldSeparator.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a Run node is encountered in the document.
             */
            public int visitRun(final Run run) throws Exception {
                if (run.getFont().getHidden()) {
                    run.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a Paragraph node is encountered in the document.
             */
            public int visitParagraphStart(final Paragraph paragraph) throws Exception {
                if (paragraph.getParagraphBreakFont().getHidden()) {
                    paragraph.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a FormField is encountered in the document.
             */
            public int visitFormField(final FormField field) throws Exception {
                if (field.getFont().getHidden()) {
                    field.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a GroupShape is encountered in the document.
             */
            public int visitGroupShapeStart(final GroupShape groupShape) throws Exception {
                if (groupShape.getFont().getHidden()) {
                    groupShape.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a Shape is encountered in the document.
             */
            public int visitShapeStart(final Shape shape) throws Exception {
                if (shape.getFont().getHidden()) {
                    shape.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a Comment is encountered in the document.
             */
            public int visitCommentStart(final Comment comment) throws Exception {
                if (comment.getFont().getHidden()) {
                    comment.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a Footnote is encountered in the document.
             */
            public int visitFootnoteStart(final Footnote footnote) throws Exception {
                if (footnote.getFont().getHidden()) {
                    footnote.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when visiting of a Table node is ended in the document.
             */
            public int visitTableEnd(final Table table) {
                // At the moment there is no way to tell if a particular Table/Row/Cell is hidden.
                // Instead, if the content of a table is hidden, then all inline child nodes of the table should be
                // hidden and thus removed by previous visits as well. This will result in the container being empty
                // so if this is the case we know to remove the table node.
                //
                // Note that a table which is not hidden but simply has no content will not be affected by this algorithm,
                // as technically they are not completely empty (for example a properly formed Cell will have at least 
                // an empty paragraph in it)
                if (!table.hasChildNodes()) {
                    table.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when visiting of a Cell node is ended in the document.
             */
            public int visitCellEnd(final Cell cell) {
                if (!cell.hasChildNodes() && cell.getParentNode() != null) {
                    cell.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when visiting of a Row node is ended in the document.
             */
            public int visitRowEnd(final Row row) {
                if (!row.hasChildNodes() && row.getParentNode() != null) {
                    row.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
      • getParagraphFormat

        public ParagraphFormat getParagraphFormat()
        
        Provides access to the paragraph formatting properties.

        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");
      • 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()
        
        Retrieves the parent Section of the 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");
      • getParentStory

        public Story getParentStory()
        
        Retrieves the parent section-level story that can be Body or HeaderFooter.

        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");
      • 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());
      • getRuns

        public RunCollection getRuns()
        
        Provides access to the typed collection of pieces of text inside the paragraph.

        Example:

        Shows how to view revision-related properties of Inline nodes.
        Document doc = new Document(getMyDir() + "Revision runs.docx");
        
        // This document has 6 revisions
        Assert.assertEquals(doc.getRevisions().getCount(), 6);
        
        // The parent node of a revision is the run that the revision concerns, which is an Inline node
        Run run = (Run) doc.getRevisions().get(0).getParentNode();
        
        // Get the parent paragraph
        Paragraph firstParagraph = run.getParentParagraph();
        RunCollection runs = firstParagraph.getRuns();
        
        Assert.assertEquals(runs.getCount(), 6);
        
        // The text in the run at index #2 was typed after revisions were tracked, so it will count as an insert revision
        // The font was changed, so it will also be a format revision
        Assert.assertTrue(runs.get(2).isInsertRevision());
        Assert.assertTrue(runs.get(2).isFormatRevision());
        
        // If one node was moved from one place to another while changes were tracked,
        // the node will be placed at the departure location as a "move to revision",
        // and a "move from revision" node will be left behind at the origin, in case we want to reject changes
        // Highlighting text and dragging it to another place with the mouse and cut-and-pasting (but not copy-pasting) both count as "move revisions"
        // The node with the "IsMoveToRevision" flag is the arrival of the move operation, and the node with the "IsMoveFromRevision" flag is the departure point
        Assert.assertTrue(runs.get(1).isMoveToRevision());
        Assert.assertTrue(runs.get(4).isMoveFromRevision());
        
        // If an Inline node gets deleted while changes are being tracked, it will leave behind a node with the IsDeleteRevision flag set to true until changes are accepted
        Assert.assertTrue(runs.get(5).isDeleteRevision());
    • 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.VisitParagraphStart, then calls Accept for all child nodes of the paragraph and calls DocumentVisitor.VisitParagraphEnd 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:

        Implements the Visitor Pattern to remove all content formatted as hidden from the document.
        public void removeHiddenContentFromDocument() throws Exception {
            // Open the document we want to remove hidden content from
            Document doc = new Document(getMyDir() + "Hidden content.docx");
        
            // Create an object that inherits from the DocumentVisitor class
            RemoveHiddenContentVisitor hiddenContentRemover = new RemoveHiddenContentVisitor();
        
            // This is the well known Visitor pattern. Get the model to accept a visitor
            // The model will iterate through itself by calling the corresponding methods
            // on the visitor object (this is called visiting)
        
            // We can run it over the entire the document like so
            doc.accept(hiddenContentRemover);
        
            // Or we can run it on only a specific node
            Paragraph para = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 4, true);
            para.accept(hiddenContentRemover);
        
            // Or over a different type of node like below
            Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
            table.accept(hiddenContentRemover);
        
            doc.save(getArtifactsDir() + "Font.RemoveHiddenContentFromDocument.docx");
        }
        
        /**
         * This class when executed will remove all hidden content from the Document. Implemented as a Visitor.
         */
        private class RemoveHiddenContentVisitor extends DocumentVisitor {
            /**
             * Called when a FieldStart node is encountered in the document.
             */
            public int visitFieldStart(final FieldStart fieldStart) throws Exception {
                // If this node is hidden, then remove it
                if (fieldStart.getFont().getHidden()) {
                    fieldStart.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a FieldEnd node is encountered in the document.
             */
            public int visitFieldEnd(final FieldEnd fieldEnd) throws Exception {
                if (fieldEnd.getFont().getHidden()) {
                    fieldEnd.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a FieldSeparator node is encountered in the document.
             */
            public int visitFieldSeparator(final FieldSeparator fieldSeparator) throws Exception {
                if (fieldSeparator.getFont().getHidden()) {
                    fieldSeparator.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a Run node is encountered in the document.
             */
            public int visitRun(final Run run) throws Exception {
                if (run.getFont().getHidden()) {
                    run.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a Paragraph node is encountered in the document.
             */
            public int visitParagraphStart(final Paragraph paragraph) throws Exception {
                if (paragraph.getParagraphBreakFont().getHidden()) {
                    paragraph.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a FormField is encountered in the document.
             */
            public int visitFormField(final FormField field) throws Exception {
                if (field.getFont().getHidden()) {
                    field.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a GroupShape is encountered in the document.
             */
            public int visitGroupShapeStart(final GroupShape groupShape) throws Exception {
                if (groupShape.getFont().getHidden()) {
                    groupShape.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a Shape is encountered in the document.
             */
            public int visitShapeStart(final Shape shape) throws Exception {
                if (shape.getFont().getHidden()) {
                    shape.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a Comment is encountered in the document.
             */
            public int visitCommentStart(final Comment comment) throws Exception {
                if (comment.getFont().getHidden()) {
                    comment.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when a Footnote is encountered in the document.
             */
            public int visitFootnoteStart(final Footnote footnote) throws Exception {
                if (footnote.getFont().getHidden()) {
                    footnote.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when visiting of a Table node is ended in the document.
             */
            public int visitTableEnd(final Table table) {
                // At the moment there is no way to tell if a particular Table/Row/Cell is hidden.
                // Instead, if the content of a table is hidden, then all inline child nodes of the table should be
                // hidden and thus removed by previous visits as well. This will result in the container being empty
                // so if this is the case we know to remove the table node.
                //
                // Note that a table which is not hidden but simply has no content will not be affected by this algorithm,
                // as technically they are not completely empty (for example a properly formed Cell will have at least 
                // an empty paragraph in it)
                if (!table.hasChildNodes()) {
                    table.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when visiting of a Cell node is ended in the document.
             */
            public int visitCellEnd(final Cell cell) {
                if (!cell.hasChildNodes() && cell.getParentNode() != null) {
                    cell.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
        
            /**
             * Called when visiting of a Row node is ended in the document.
             */
            public int visitRowEnd(final Row row) {
                if (!row.hasChildNodes() && row.getParentNode() != null) {
                    row.remove();
                }
        
                return VisitorAction.CONTINUE;
            }
      • 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");
      • appendField

        public Field appendField(int fieldType, boolean updateField)
                         throws java.lang.Exception
        Appends a field to this paragraph.
        Parameters:
        fieldType - A FieldType value. The type of the field to append.
        updateField - Specifies whether to update the field immediately.
        Returns:
        A Field object that represents the appended field.

        Example:

        Shows how to insert fields in different ways.
        // Create a blank document and get its first paragraph
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // Choose a DATE field by FieldType, append it to the end of the paragraph and update it
        para.appendField(FieldType.FIELD_DATE, true);
        
        // Append a TIME field using a field code 
        para.appendField(" TIME  \\@ \"HH:mm:ss\" ");
        
        // Append a QUOTE field that will display a placeholder value until it is updated manually in Microsoft Word
        // or programmatically with Document.UpdateFields() or Field.Update()
        para.appendField(" QUOTE \"Real value\"", "Placeholder value");
        
        // We can choose a node in the paragraph and insert a field
        // before or after that node instead of appending it to the end of a paragraph
        para = doc.getFirstSection().getBody().appendParagraph("");
        Run run = new Run(doc);
        {
            run.setText(" My Run. ");
        }
        para.appendChild(run);
        
        // Insert an AUTHOR field into the paragraph and place it before the run we created
        doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe");
        para.insertField(FieldType.FIELD_AUTHOR, true, run, false);
        
        // Insert another field designated by field code before the run
        para.insertField(" QUOTE \"Real value\" ", run, false);
        
        // Insert another field with a place holder value and place it after the run
        para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true);
        
        doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
      • appendField

        public Field appendField(java.lang.String fieldCode)
                         throws java.lang.Exception
        Appends a field to this paragraph.
        Parameters:
        fieldCode - The field code to append (without curly braces).
        Returns:
        A Field object that represents the appended field.

        Example:

        Shows how to insert fields in different ways.
        // Create a blank document and get its first paragraph
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // Choose a DATE field by FieldType, append it to the end of the paragraph and update it
        para.appendField(FieldType.FIELD_DATE, true);
        
        // Append a TIME field using a field code 
        para.appendField(" TIME  \\@ \"HH:mm:ss\" ");
        
        // Append a QUOTE field that will display a placeholder value until it is updated manually in Microsoft Word
        // or programmatically with Document.UpdateFields() or Field.Update()
        para.appendField(" QUOTE \"Real value\"", "Placeholder value");
        
        // We can choose a node in the paragraph and insert a field
        // before or after that node instead of appending it to the end of a paragraph
        para = doc.getFirstSection().getBody().appendParagraph("");
        Run run = new Run(doc);
        {
            run.setText(" My Run. ");
        }
        para.appendChild(run);
        
        // Insert an AUTHOR field into the paragraph and place it before the run we created
        doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe");
        para.insertField(FieldType.FIELD_AUTHOR, true, run, false);
        
        // Insert another field designated by field code before the run
        para.insertField(" QUOTE \"Real value\" ", run, false);
        
        // Insert another field with a place holder value and place it after the run
        para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true);
        
        doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
      • appendField

        public Field appendField(java.lang.String fieldCode, java.lang.String fieldValue)
        Appends a field to this paragraph.
        Parameters:
        fieldCode - The field code to append (without curly braces).
        fieldValue - The field value to append. Pass null for fields that do not have a value.
        Returns:
        A Field object that represents the appended field.

        Example:

        Shows how to insert fields in different ways.
        // Create a blank document and get its first paragraph
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // Choose a DATE field by FieldType, append it to the end of the paragraph and update it
        para.appendField(FieldType.FIELD_DATE, true);
        
        // Append a TIME field using a field code 
        para.appendField(" TIME  \\@ \"HH:mm:ss\" ");
        
        // Append a QUOTE field that will display a placeholder value until it is updated manually in Microsoft Word
        // or programmatically with Document.UpdateFields() or Field.Update()
        para.appendField(" QUOTE \"Real value\"", "Placeholder value");
        
        // We can choose a node in the paragraph and insert a field
        // before or after that node instead of appending it to the end of a paragraph
        para = doc.getFirstSection().getBody().appendParagraph("");
        Run run = new Run(doc);
        {
            run.setText(" My Run. ");
        }
        para.appendChild(run);
        
        // Insert an AUTHOR field into the paragraph and place it before the run we created
        doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe");
        para.insertField(FieldType.FIELD_AUTHOR, true, run, false);
        
        // Insert another field designated by field code before the run
        para.insertField(" QUOTE \"Real value\" ", run, false);
        
        // Insert another field with a place holder value and place it after the run
        para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true);
        
        doc.save(getArtifactsDir() + "Paragraph.InsertField.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());
      • 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");
            int tableIndex = 0;
        
            for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true)) {
                // First lets find if any cells in the table have tables themselves as children
                int count = getChildTableCount(table);
                System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count));
        
                // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth
                int tableDepth = getNestedDepthOfTable(table);
        
                if (tableDepth > 0) {
                    System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth));
                } else {
                    System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex));
                }
        
                tableIndex++;
            }
        }
        
        /**
         * Calculates what level a table is nested inside other tables.
         *
         * @returns An integer containing the level the table is nested at.
         * 0 = Table is not nested inside any other table
         * 1 = Table is nested within one parent table
         * 2 = Table is nested within two parent tables etc..
         */
        private static int getNestedDepthOfTable(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");
            int tableIndex = 0;
        
            for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true)) {
                // First lets find if any cells in the table have tables themselves as children
                int count = getChildTableCount(table);
                System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count));
        
                // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth
                int tableDepth = getNestedDepthOfTable(table);
        
                if (tableDepth > 0) {
                    System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth));
                } else {
                    System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex));
                }
        
                tableIndex++;
            }
        }
        
        /**
         * Calculates what level a table is nested inside other tables.
         *
         * @returns An integer containing the level the table is nested at.
         * 0 = Table is not nested inside any other table
         * 1 = Table is nested within one parent table
         * 2 = Table is nested within two parent tables etc..
         */
        private static int getNestedDepthOfTable(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);
      • getEffectiveTabStops

        public TabStop[] getEffectiveTabStops()
        Returns array of all tab stops applied to this paragraph, including applied indirectly by styles or lists.

        Example:

        Shows how to set custom tab stops.
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // If there are no tab stops in this collection, while we are in this paragraph
        // the cursor will jump 36 points each time we press the Tab key in Microsoft Word
        Assert.assertEquals(para.getEffectiveTabStops().length, 0);
        
        // We can add custom tab stops in Microsoft Word if we enable the ruler via the view tab
        // Each unit on that ruler is two default tab stops, which is 72 points
        // Those tab stops can be programmatically added to the paragraph like this
        ParagraphFormat format = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat();
        format.getTabStops().add(72.0, TabAlignment.LEFT, TabLeader.DOTS);
        format.getTabStops().add(216.0, TabAlignment.CENTER, TabLeader.DASHES);
        format.getTabStops().add(360.0, TabAlignment.RIGHT, TabLeader.LINE);
        
        // These tab stops are added to this collection, and can also be seen by enabling the ruler mentioned above
        Assert.assertEquals(para.getEffectiveTabStops().length, 3);
        
        // Add a Run with tab characters that will snap the text to our TabStop positions and save the document
        para.appendChild(new Run(doc, "\tTab 1\tTab 2\tTab 3"));
        doc.save(getArtifactsDir() + "Paragraph.TabStops.docx");
      • getText

        public java.lang.String getText()
        Gets the text of this paragraph including the end of paragraph character.

        The text of all child nodes is concatenated and the end of paragraph character is appended as follows:

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

        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());
      • 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.doc");

        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());
      • insertField

        public Field insertField(int fieldType, boolean updateField, Node refNode, boolean isAfter)
                         throws java.lang.Exception
        Inserts a field into this paragraph.
        Parameters:
        fieldType - A FieldType value. The type of the field to insert.
        updateField - Specifies whether to update the field immediately.
        refNode - Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).
        isAfter - Whether to insert the field after or before reference node.
        Returns:
        A Field object that represents the inserted field.

        Example:

        Shows how to insert fields in different ways.
        // Create a blank document and get its first paragraph
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // Choose a DATE field by FieldType, append it to the end of the paragraph and update it
        para.appendField(FieldType.FIELD_DATE, true);
        
        // Append a TIME field using a field code 
        para.appendField(" TIME  \\@ \"HH:mm:ss\" ");
        
        // Append a QUOTE field that will display a placeholder value until it is updated manually in Microsoft Word
        // or programmatically with Document.UpdateFields() or Field.Update()
        para.appendField(" QUOTE \"Real value\"", "Placeholder value");
        
        // We can choose a node in the paragraph and insert a field
        // before or after that node instead of appending it to the end of a paragraph
        para = doc.getFirstSection().getBody().appendParagraph("");
        Run run = new Run(doc);
        {
            run.setText(" My Run. ");
        }
        para.appendChild(run);
        
        // Insert an AUTHOR field into the paragraph and place it before the run we created
        doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe");
        para.insertField(FieldType.FIELD_AUTHOR, true, run, false);
        
        // Insert another field designated by field code before the run
        para.insertField(" QUOTE \"Real value\" ", run, false);
        
        // Insert another field with a place holder value and place it after the run
        para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true);
        
        doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
      • insertField

        public Field insertField(java.lang.String fieldCode, Node refNode, boolean isAfter)
                         throws java.lang.Exception
        Inserts a field into this paragraph.
        Parameters:
        fieldCode - The field code to insert (without curly braces).
        refNode - Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).
        isAfter - Whether to insert the field after or before reference node.
        Returns:
        A Field object that represents the inserted field.

        Example:

        Shows how to insert fields in different ways.
        // Create a blank document and get its first paragraph
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // Choose a DATE field by FieldType, append it to the end of the paragraph and update it
        para.appendField(FieldType.FIELD_DATE, true);
        
        // Append a TIME field using a field code 
        para.appendField(" TIME  \\@ \"HH:mm:ss\" ");
        
        // Append a QUOTE field that will display a placeholder value until it is updated manually in Microsoft Word
        // or programmatically with Document.UpdateFields() or Field.Update()
        para.appendField(" QUOTE \"Real value\"", "Placeholder value");
        
        // We can choose a node in the paragraph and insert a field
        // before or after that node instead of appending it to the end of a paragraph
        para = doc.getFirstSection().getBody().appendParagraph("");
        Run run = new Run(doc);
        {
            run.setText(" My Run. ");
        }
        para.appendChild(run);
        
        // Insert an AUTHOR field into the paragraph and place it before the run we created
        doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe");
        para.insertField(FieldType.FIELD_AUTHOR, true, run, false);
        
        // Insert another field designated by field code before the run
        para.insertField(" QUOTE \"Real value\" ", run, false);
        
        // Insert another field with a place holder value and place it after the run
        para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true);
        
        doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
      • insertField

        public Field insertField(java.lang.String fieldCode, java.lang.String fieldValue, Node refNode, boolean isAfter)
        Inserts a field into this paragraph.
        Parameters:
        fieldCode - The field code to insert (without curly braces).
        fieldValue - The field value to insert. Pass null for fields that do not have a value.
        refNode - Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).
        isAfter - Whether to insert the field after or before reference node.
        Returns:
        A Field object that represents the inserted field.

        Example:

        Shows how to insert fields in different ways.
        // Create a blank document and get its first paragraph
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // Choose a DATE field by FieldType, append it to the end of the paragraph and update it
        para.appendField(FieldType.FIELD_DATE, true);
        
        // Append a TIME field using a field code 
        para.appendField(" TIME  \\@ \"HH:mm:ss\" ");
        
        // Append a QUOTE field that will display a placeholder value until it is updated manually in Microsoft Word
        // or programmatically with Document.UpdateFields() or Field.Update()
        para.appendField(" QUOTE \"Real value\"", "Placeholder value");
        
        // We can choose a node in the paragraph and insert a field
        // before or after that node instead of appending it to the end of a paragraph
        para = doc.getFirstSection().getBody().appendParagraph("");
        Run run = new Run(doc);
        {
            run.setText(" My Run. ");
        }
        para.appendChild(run);
        
        // Insert an AUTHOR field into the paragraph and place it before the run we created
        doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe");
        para.insertField(FieldType.FIELD_AUTHOR, true, run, false);
        
        // Insert another field designated by field code before the run
        para.insertField(" QUOTE \"Real value\" ", run, false);
        
        // Insert another field with a place holder value and place it after the run
        para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true);
        
        doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
      • 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());
            }
      • joinRunsWithSameFormatting

        public int joinRunsWithSameFormatting()
        Joins runs with the same formatting in the paragraph.
        Returns:
        Number of joins performed. When N adjacent runs are being joined they count as N - 1 joins.

        Example:

        Shows how to simplify paragraphs by merging superfluous runs.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a few small runs into the document
        builder.write("Run 1. ");
        builder.write("Run 2. ");
        builder.write("Run 3. ");
        builder.write("Run 4. ");
        
        // The Paragraph may look like it's in once piece in Microsoft Word,
        // but it is fragmented into several Runs, which leaves room for optimization
        // A big run may be split into many smaller runs with the same formatting
        // if we keep splitting up a piece of text while manually editing it in Microsoft Word
        Paragraph para = builder.getCurrentParagraph();
        Assert.assertEquals(para.getRuns().getCount(), 4);
        
        // Change the style of the last run to something different from the first three
        para.getRuns().get(3).getFont().setStyleIdentifier(StyleIdentifier.EMPHASIS);
        
        // We can run the JoinRunsWithSameFormatting() method to merge similar Runs
        // This method also returns the number of joins that occured during the merge
        // Two merges occured to combine Runs 1-3, while Run 4 was left out because it has an incompatible style
        Assert.assertEquals(para.joinRunsWithSameFormatting(), 2);
        
        // The paragraph has been simplified to two runs
        Assert.assertEquals(2, para.getRuns().getCount());
        Assert.assertEquals("Run 1. Run 2. Run 3. ", para.getRuns().get(0).getText());
        Assert.assertEquals("Run 4. ", para.getRuns().get(1).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:

        Shows how to create smart tags.
        public void smartTags() throws Exception {
            Document doc = new Document();
            SmartTag smartTag = new SmartTag(doc);
            smartTag.setElement("date");
        
            // Specify a date and set smart tag properties accordingly
            smartTag.appendChild(new Run(doc, "May 29, 2019"));
        
            smartTag.getProperties().add(new CustomXmlProperty("Day", "", "29"));
            smartTag.getProperties().add(new CustomXmlProperty("Month", "", "5"));
            smartTag.getProperties().add(new CustomXmlProperty("Year", "", "2019"));
        
            // Set the smart tag's uri to the default
            smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");
        
            doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
            doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a date. "));
        
            // Create and add one more smart tag, this time for a financial symbol
            smartTag = new SmartTag(doc);
            smartTag.setElement("stockticker");
            smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");
        
            smartTag.appendChild(new Run(doc, "MSFT"));
        
            doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
            doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a stock ticker."));
        
            // Print all the smart tags in our document with a document visitor
            doc.accept(new SmartTagVisitor());
        
            // SmartTags are supported by older versions of microsoft Word
            doc.save(getArtifactsDir() + "StructuredDocumentTag.SmartTags.doc");
        
            // We can strip a document of all its smart tags with RemoveSmartTags()
            Assert.assertEquals(2, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
            doc.removeSmartTags();
            Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
        }
        
        /// <summary>
        /// DocumentVisitor implementation that prints smart tags and their contents.
        /// </summary>
        private static class SmartTagVisitor extends DocumentVisitor {
            /// <summary>
            /// Called when a SmartTag node is encountered in the document.
            /// </summary>
            public int visitSmartTagStart(SmartTag smartTag) {
                System.out.println(MessageFormat.format("Smart tag type: {0}", smartTag.getElement()));
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when the visiting of a SmartTag node is ended.
            /// </summary>
            public int visitSmartTagEnd(SmartTag smartTag) throws Exception {
                System.out.println(MessageFormat.format("\tContents: \"{0}\"", smartTag.toString(SaveFormat.TEXT)));
        
                if (smartTag.getProperties().getCount() == 0) {
                    System.out.println("\tContains no properties");
        
                } else {
                    System.out.println("\tProperties: ");
                    String[] properties = new String[smartTag.getProperties().getCount()];
                    int index = 0;
        
                    for (CustomXmlProperty cxp : smartTag.getProperties()) {
                        properties[index++] = MessageFormat.format("\"{0}\" = \"{1}\"", cxp.getName(), cxp.getValue());
                    }
        
                    System.out.println(String.join(", ", properties));
                }
        
                return VisitorAction.CONTINUE;
            }
        }

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