com.aspose.words

Class GlossaryDocument

  • All Implemented Interfaces:
    java.lang.Iterable, java.lang.Cloneable
    public class GlossaryDocument 
    extends DocumentBase

Represents the root element for a glossary document within a Word document. A glossary document is a storage for AutoText, AutoCorrect entries and Building Blocks.

Some documents, usually templates, can contain AutoText, AutoCorrect entries and/or Building Blocks (also known as glossary document entries, document parts or building blocks).

To access building blocks, you need to load a document into a Document object. Building blocks will be available via the Document.GlossaryDocument property.

GlossaryDocument can contain any number of BuildingBlock objects. Each BuildingBlock represents one document part.

Corresponds to the glossaryDocument and docParts elements in OOXML.

Example:

Shows ways of accessing building blocks in a glossary document.
public void glossaryDocument() throws Exception {
    Document doc = new Document();
    GlossaryDocument glossaryDoc = new GlossaryDocument();

    glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 1"));
    glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 2"));
    glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 3"));
    glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 4"));
    glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 5"));

    Assert.assertEquals(glossaryDoc.getBuildingBlocks().getCount(), 5);

    doc.setGlossaryDocument(glossaryDoc);

    // There are various ways of accessing building blocks.
    // 1 -  Get the first/last building blocks in the collection:
    Assert.assertEquals("Block 1", glossaryDoc.getFirstBuildingBlock().getName());
    Assert.assertEquals("Block 5", glossaryDoc.getLastBuildingBlock().getName());

    // 2 -  Get a building block by index:
    Assert.assertEquals("Block 2", glossaryDoc.getBuildingBlocks().get(1).getName());
    Assert.assertEquals("Block 3", glossaryDoc.getBuildingBlocks().toArray()[2].getName());

    // 3 -  Get the first building block that matches a gallery, name and category:
    Assert.assertEquals("Block 4",
            glossaryDoc.getBuildingBlock(BuildingBlockGallery.ALL, "(Empty Category)", "Block 4").getName());

    // We will do that using a custom visitor,
    // which will give every BuildingBlock in the GlossaryDocument a unique GUID
    GlossaryDocVisitor visitor = new GlossaryDocVisitor();
    glossaryDoc.accept(visitor);

    System.out.println(visitor.getText());

    // When we open this document using Microsoft Word,
    // we can find the building blocks via Insert -> Quick Parts -> Building Blocks Organizer.
    doc.save(getArtifactsDir() + "BuildingBlocks.GlossaryDocument.dotx");
}

public static BuildingBlock createNewBuildingBlock(final GlossaryDocument glossaryDoc, final String buildingBlockName) {
    BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc);
    buildingBlock.setName(buildingBlockName);

    return buildingBlock;
}

/// <summary>
/// Gives each building block in a visited glossary document a unique GUID, and stores the GUID-building block pairs in a dictionary.
/// </summary>
public static class GlossaryDocVisitor extends DocumentVisitor {
    public GlossaryDocVisitor() {
        mBlocksByGuid = new HashMap<>();
        mBuilder = new StringBuilder();
    }

    public String getText() {
        return mBuilder.toString();
    }

    public HashMap<UUID, BuildingBlock> getDictionary() {
        return mBlocksByGuid;
    }

    public int visitGlossaryDocumentStart(final GlossaryDocument glossary) {
        mBuilder.append("Glossary document found!\n");
        return VisitorAction.CONTINUE;
    }

    public int visitGlossaryDocumentEnd(final GlossaryDocument glossary) {
        mBuilder.append("Reached end of glossary!\n");
        mBuilder.append("BuildingBlocks found: " + mBlocksByGuid.size() + "\r\n");
        return VisitorAction.CONTINUE;
    }

    public int visitBuildingBlockStart(final BuildingBlock block) {
        block.setGuid(UUID.randomUUID());
        mBlocksByGuid.put(block.getGuid(), block);
        return VisitorAction.CONTINUE;
    }

    public int visitBuildingBlockEnd(final BuildingBlock block) {
        mBuilder.append("\tVisited block \"" + block.getName() + "\"" + "\r\n");
        mBuilder.append("\t Type: " + block.getType() + "\r\n");
        mBuilder.append("\t Gallery: " + block.getGallery() + "\r\n");
        mBuilder.append("\t Behavior: " + block.getBehavior() + "\r\n");
        mBuilder.append("\t Description: " + block.getDescription() + "\r\n");

        return VisitorAction.CONTINUE;
    }

    private final HashMap<UUID, BuildingBlock> mBlocksByGuid;
    private final StringBuilder mBuilder;
}
See Also:
Document, Document.GlossaryDocument, BuildingBlock

Constructor Summary
 
Property Getters/Setters Summary
ShapegetBackgroundShape()
void
           Gets or sets the background shape of the document. Can be null.
BuildingBlockCollectiongetBuildingBlocks()
Returns a typed collection that represents all building blocks in the glossary document.
NodeCollectiongetChildNodes()
Gets all immediate child nodes of this node.
intgetCount()
Gets the number of immediate children of this node.
intgetCustomNodeId()
void
setCustomNodeId(intvalue)
           Specifies custom node identifier.
DocumentBasegetDocument()
BuildingBlockgetFirstBuildingBlock()
Gets the first building block in the glossary document.
NodegetFirstChild()
Gets the first child of the node.
FontInfoCollectiongetFontInfos()
Provides access to properties of fonts used in this document.
booleanhasChildNodes()
Returns true if this node has any child nodes.
booleanisComposite()
Returns true as this node can have child nodes.
BuildingBlockgetLastBuildingBlock()
Gets the last building block in the glossary document.
NodegetLastChild()
Gets the last child of the node.
ListCollectiongetLists()
Provides access to the list formatting used in the document.
NodegetNextSibling()
Gets the node immediately following this node.
INodeChangingCallbackgetNodeChangingCallback()
void
           Called when a node is inserted or removed in the document.
intgetNodeType()
Returns the NodeType.GLOSSARY_DOCUMENT value. The value of the property is NodeType integer constant.
java.awt.ColorgetPageColor()
void
setPageColor(java.awt.Colorvalue)
           Gets or sets the page color of the document. This property is a simpler version of BackgroundShape.
CompositeNodegetParentNode()
Gets the immediate parent of this node.
NodegetPreviousSibling()
Gets the node immediately preceding this node.
RangegetRange()
Returns a Range object that represents the portion of a document that is contained in this node.
IResourceLoadingCallbackgetResourceLoadingCallback()
void
           Allows to control how external resources are loaded.
StyleCollectiongetStyles()
Returns a collection of styles defined in the document.
IWarningCallbackgetWarningCallback()
void
           Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss.
 
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.
NodedeepClone(boolean isCloneChildren)
Creates a duplicate of the node.
CompositeNodegetAncestor(int ancestorType)
Gets the first ancestor of the specified NodeType.
CompositeNodegetAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.
BuildingBlockgetBuildingBlock(int gallery, java.lang.String category, java.lang.String name)
Finds a building block using the specified gallery, category and name.
NodegetChild(int nodeType, int index, boolean isDeep)
Returns an Nth child node that matches the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep)
Returns a live collection of child nodes that match the specified type.
java.lang.StringgetText()
Gets the text of this node and of all its children.
NodeimportNode(Node srcNode, boolean isImportChildren)

Imports a node from another document to the current document.

NodeimportNode(Node srcNode, boolean isImportChildren, int importFormatMode)

Imports a node from another document to the current document with an option to control formatting.

intindexOf(Node child)
Returns the index of the specified child node in the child node array.
NodeinsertAfter(Node newChild, Node refChild)
Inserts the specified node immediately after the specified reference node.
NodeinsertBefore(Node newChild, Node refChild)
Inserts the specified node immediately before the specified reference node.
java.util.Iterator<Node>iterator()
Provides support for the for each style iteration over the child nodes of this node.
NodenextPreOrder(Node rootNode)
Gets next node according to the pre-order tree traversal algorithm.
NodeprependChild(Node newChild)
Adds the specified node to the beginning of the list of child nodes for this node.
NodepreviousPreOrder(Node rootNode)
Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()
Removes itself from the parent.
voidremoveAllChildren()
Removes all the child nodes of the current node.
NoderemoveChild(Node oldChild)
Removes the specified child node.
voidremoveSmartTags()
Removes all SmartTag descendant nodes of the current node.
NodeListselectNodes(java.lang.String xpath)
Selects a list of nodes matching the XPath expression.
NodeselectSingleNode(java.lang.String xpath)
Selects the first Node that matches the XPath expression.
java.lang.StringtoString(SaveOptions saveOptions)
Exports the content of the node into a string using the specified save options.
java.lang.StringtoString(int saveFormat)
Exports the content of the node into a string in the specified format.
 

    • Constructor Detail

      • GlossaryDocument

        public GlossaryDocument()
    • Property Getters/Setters Detail

      • getBackgroundShape/setBackgroundShape

        public Shape getBackgroundShape() / public void setBackgroundShape(Shape value)
        
        Gets or sets the background shape of the document. Can be null.

        Microsoft Word allows only a shape that has its ShapeBase.ShapeType property equal to ShapeType.RECTANGLE to be used as a background shape for a document.

        Microsoft Word supports only the fill properties of a background shape. All other properties are ignored.

        Setting this property to a non-null value will also set the ViewOptions.DisplayBackgroundShape to true.

        Example:

        Shows how to set a background shape for every page of a document.
        Document doc = new Document();
        
        Assert.assertNull(doc.getBackgroundShape());
        
        // The only shape type that we can use as a background is a rectangle.
        Shape shapeRectangle = new Shape(doc, ShapeType.RECTANGLE);
        
        // There are two ways of using this shape as a page background.
        // 1 -  A flat color:
        shapeRectangle.setFillColor(Color.BLUE);
        doc.setBackgroundShape(shapeRectangle);
        
        doc.save(getArtifactsDir() + "DocumentBase.BackgroundShape.FlatColor.docx");
        
        // 2 -  An image:
        shapeRectangle = new Shape(doc, ShapeType.RECTANGLE);
        shapeRectangle.getImageData().setImage(getImageDir() + "Transparent background logo.png");
        
        // Adjust the image's appearance to make it more suitable as a watermark.
        shapeRectangle.getImageData().setContrast(0.2);
        shapeRectangle.getImageData().setBrightness(0.7);
        
        doc.setBackgroundShape(shapeRectangle);
        
        Assert.assertTrue(doc.getBackgroundShape().hasImage());
        
        // Microsoft Word does not support shapes with images as backgrounds,
        // but we can still see these backgrounds in other save formats such as .pdf.
        doc.save(getArtifactsDir() + "DocumentBase.BackgroundShape.Image.pdf");
        See Also:
        ViewOptions.DisplayBackgroundShape, PageColor
      • getBuildingBlocks

        public BuildingBlockCollection getBuildingBlocks()
        
        Returns a typed collection that represents all building blocks in the glossary document.

        Example:

        Shows ways of accessing building blocks in a glossary document.
        public void glossaryDocument() throws Exception {
            Document doc = new Document();
            GlossaryDocument glossaryDoc = new GlossaryDocument();
        
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 1"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 2"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 3"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 4"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 5"));
        
            Assert.assertEquals(glossaryDoc.getBuildingBlocks().getCount(), 5);
        
            doc.setGlossaryDocument(glossaryDoc);
        
            // There are various ways of accessing building blocks.
            // 1 -  Get the first/last building blocks in the collection:
            Assert.assertEquals("Block 1", glossaryDoc.getFirstBuildingBlock().getName());
            Assert.assertEquals("Block 5", glossaryDoc.getLastBuildingBlock().getName());
        
            // 2 -  Get a building block by index:
            Assert.assertEquals("Block 2", glossaryDoc.getBuildingBlocks().get(1).getName());
            Assert.assertEquals("Block 3", glossaryDoc.getBuildingBlocks().toArray()[2].getName());
        
            // 3 -  Get the first building block that matches a gallery, name and category:
            Assert.assertEquals("Block 4",
                    glossaryDoc.getBuildingBlock(BuildingBlockGallery.ALL, "(Empty Category)", "Block 4").getName());
        
            // We will do that using a custom visitor,
            // which will give every BuildingBlock in the GlossaryDocument a unique GUID
            GlossaryDocVisitor visitor = new GlossaryDocVisitor();
            glossaryDoc.accept(visitor);
        
            System.out.println(visitor.getText());
        
            // When we open this document using Microsoft Word,
            // we can find the building blocks via Insert -> Quick Parts -> Building Blocks Organizer.
            doc.save(getArtifactsDir() + "BuildingBlocks.GlossaryDocument.dotx");
        }
        
        public static BuildingBlock createNewBuildingBlock(final GlossaryDocument glossaryDoc, final String buildingBlockName) {
            BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc);
            buildingBlock.setName(buildingBlockName);
        
            return buildingBlock;
        }
        
        /// <summary>
        /// Gives each building block in a visited glossary document a unique GUID, and stores the GUID-building block pairs in a dictionary.
        /// </summary>
        public static class GlossaryDocVisitor extends DocumentVisitor {
            public GlossaryDocVisitor() {
                mBlocksByGuid = new HashMap<>();
                mBuilder = new StringBuilder();
            }
        
            public String getText() {
                return mBuilder.toString();
            }
        
            public HashMap<UUID, BuildingBlock> getDictionary() {
                return mBlocksByGuid;
            }
        
            public int visitGlossaryDocumentStart(final GlossaryDocument glossary) {
                mBuilder.append("Glossary document found!\n");
                return VisitorAction.CONTINUE;
            }
        
            public int visitGlossaryDocumentEnd(final GlossaryDocument glossary) {
                mBuilder.append("Reached end of glossary!\n");
                mBuilder.append("BuildingBlocks found: " + mBlocksByGuid.size() + "\r\n");
                return VisitorAction.CONTINUE;
            }
        
            public int visitBuildingBlockStart(final BuildingBlock block) {
                block.setGuid(UUID.randomUUID());
                mBlocksByGuid.put(block.getGuid(), block);
                return VisitorAction.CONTINUE;
            }
        
            public int visitBuildingBlockEnd(final BuildingBlock block) {
                mBuilder.append("\tVisited block \"" + block.getName() + "\"" + "\r\n");
                mBuilder.append("\t Type: " + block.getType() + "\r\n");
                mBuilder.append("\t Gallery: " + block.getGallery() + "\r\n");
                mBuilder.append("\t Behavior: " + block.getBehavior() + "\r\n");
                mBuilder.append("\t Description: " + block.getDescription() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            private final HashMap<UUID, BuildingBlock> mBlocksByGuid;
            private final StringBuilder mBuilder;
        }
      • 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 traverse through a composite node's collection of child nodes.
        Document doc = new Document();
        
        // Add two runs and one shape as child nodes to the first paragraph of this document.
        Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
        paragraph.appendChild(new Run(doc, "Hello world! "));
        
        Shape shape = new Shape(doc, ShapeType.RECTANGLE);
        shape.setWidth(200.0);
        shape.setHeight(200.0);
        shape.setWrapType(WrapType.INLINE);
        paragraph.appendChild(shape);
        
        paragraph.appendChild(new Run(doc, "Hello again!"));
        
        // Iterate through the paragraph's collection of immediate children,
        // and print any runs or shapes that we find within.
        NodeCollection children = paragraph.getChildNodes();
        
        Assert.assertEquals(3, paragraph.getChildNodes().getCount());
        
        for (Node child : (Iterable<Node>) children)
            switch (child.getNodeType()) {
                case NodeType.RUN:
                    System.out.println("Run contents:");
                    System.out.println("\t\"{child.GetText().Trim()}\"");
                    break;
                case NodeType.SHAPE:
                    Shape childShape = (Shape) child;
                    System.out.println("Shape:");
                    System.out.println("\t{childShape.ShapeType}, {childShape.Width}x{childShape.Height}");
                    break;
            }
      • getCount

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

        Example:

        Shows how to add, update and delete child nodes in a CompositeNode's collection of children.
        Document doc = new Document();
        
        // An empty document, by default, has one paragraph.
        Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
        
        // Composite nodes such as our paragraph can contain other composite and inline nodes as children.
        Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
        Run paragraphText = new Run(doc, "Initial text. ");
        paragraph.appendChild(paragraphText);
        
        // Create three more run nodes.
        Run run1 = new Run(doc, "Run 1. ");
        Run run2 = new Run(doc, "Run 2. ");
        Run run3 = new Run(doc, "Run 3. ");
        
        // The document body will not display these runs until we insert them into a composite node
        // that itself is a part of the document's node tree, as we did with the first run.
        // We can determine where the text contents of nodes that we insert
        // appears in the document by specifying an insertion location relative to another node in the paragraph.
        Assert.assertEquals("Initial text.", paragraph.getText().trim());
        
        // Insert the second run into the paragraph in front of the initial run.
        paragraph.insertBefore(run2, paragraphText);
        
        Assert.assertEquals("Run 2. Initial text.", paragraph.getText().trim());
        
        // Insert the third run after the initial run.
        paragraph.insertAfter(run3, paragraphText);
        
        Assert.assertEquals("Run 2. Initial text. Run 3.", paragraph.getText().trim());
        
        // Insert the first run to the start of the paragraph's child nodes collection.
        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());
        
        // We can modify the contents of the run by editing and deleting existing child nodes.
        ((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());
      • getCustomNodeId/setCustomNodeId

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

        Default is zero.

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

      • getFirstBuildingBlock

        public BuildingBlock getFirstBuildingBlock()
        
        Gets the first building block in the glossary document. Returns null if there are no building blocks available.

        Example:

        Shows ways of accessing building blocks in a glossary document.
        public void glossaryDocument() throws Exception {
            Document doc = new Document();
            GlossaryDocument glossaryDoc = new GlossaryDocument();
        
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 1"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 2"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 3"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 4"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 5"));
        
            Assert.assertEquals(glossaryDoc.getBuildingBlocks().getCount(), 5);
        
            doc.setGlossaryDocument(glossaryDoc);
        
            // There are various ways of accessing building blocks.
            // 1 -  Get the first/last building blocks in the collection:
            Assert.assertEquals("Block 1", glossaryDoc.getFirstBuildingBlock().getName());
            Assert.assertEquals("Block 5", glossaryDoc.getLastBuildingBlock().getName());
        
            // 2 -  Get a building block by index:
            Assert.assertEquals("Block 2", glossaryDoc.getBuildingBlocks().get(1).getName());
            Assert.assertEquals("Block 3", glossaryDoc.getBuildingBlocks().toArray()[2].getName());
        
            // 3 -  Get the first building block that matches a gallery, name and category:
            Assert.assertEquals("Block 4",
                    glossaryDoc.getBuildingBlock(BuildingBlockGallery.ALL, "(Empty Category)", "Block 4").getName());
        
            // We will do that using a custom visitor,
            // which will give every BuildingBlock in the GlossaryDocument a unique GUID
            GlossaryDocVisitor visitor = new GlossaryDocVisitor();
            glossaryDoc.accept(visitor);
        
            System.out.println(visitor.getText());
        
            // When we open this document using Microsoft Word,
            // we can find the building blocks via Insert -> Quick Parts -> Building Blocks Organizer.
            doc.save(getArtifactsDir() + "BuildingBlocks.GlossaryDocument.dotx");
        }
        
        public static BuildingBlock createNewBuildingBlock(final GlossaryDocument glossaryDoc, final String buildingBlockName) {
            BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc);
            buildingBlock.setName(buildingBlockName);
        
            return buildingBlock;
        }
        
        /// <summary>
        /// Gives each building block in a visited glossary document a unique GUID, and stores the GUID-building block pairs in a dictionary.
        /// </summary>
        public static class GlossaryDocVisitor extends DocumentVisitor {
            public GlossaryDocVisitor() {
                mBlocksByGuid = new HashMap<>();
                mBuilder = new StringBuilder();
            }
        
            public String getText() {
                return mBuilder.toString();
            }
        
            public HashMap<UUID, BuildingBlock> getDictionary() {
                return mBlocksByGuid;
            }
        
            public int visitGlossaryDocumentStart(final GlossaryDocument glossary) {
                mBuilder.append("Glossary document found!\n");
                return VisitorAction.CONTINUE;
            }
        
            public int visitGlossaryDocumentEnd(final GlossaryDocument glossary) {
                mBuilder.append("Reached end of glossary!\n");
                mBuilder.append("BuildingBlocks found: " + mBlocksByGuid.size() + "\r\n");
                return VisitorAction.CONTINUE;
            }
        
            public int visitBuildingBlockStart(final BuildingBlock block) {
                block.setGuid(UUID.randomUUID());
                mBlocksByGuid.put(block.getGuid(), block);
                return VisitorAction.CONTINUE;
            }
        
            public int visitBuildingBlockEnd(final BuildingBlock block) {
                mBuilder.append("\tVisited block \"" + block.getName() + "\"" + "\r\n");
                mBuilder.append("\t Type: " + block.getType() + "\r\n");
                mBuilder.append("\t Gallery: " + block.getGallery() + "\r\n");
                mBuilder.append("\t Behavior: " + block.getBehavior() + "\r\n");
                mBuilder.append("\t Description: " + block.getDescription() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            private final HashMap<UUID, BuildingBlock> mBlocksByGuid;
            private final StringBuilder mBuilder;
        }
      • 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 use a node's NextSibling property to enumerate through its immediate children.
        Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
        for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) {
            System.out.println(Node.nodeTypeToString(node.getNodeType()));
        }

        Example:

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

        public FontInfoCollection getFontInfos()
        
        Provides access to properties of fonts used in this document.

        This collection of font definitions is loaded as is from the document. Font definitions might be optional, missing or incomplete in some documents.

        Do not rely on this collection to ascertain that a particular font is used in the document. You should only use this collection to get information about fonts that might be used in the document.

        Example:

        Shows how to save a document with embedded TrueType fonts.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        FontInfoCollection fontInfos = doc.getFontInfos();
        fontInfos.setEmbedTrueTypeFonts(embedAllFonts);
        fontInfos.setEmbedSystemFonts(embedAllFonts);
        fontInfos.setSaveSubsetFonts(embedAllFonts);
        
        doc.save(getArtifactsDir() + "Font.FontInfoCollection.docx");

        Example:

        Shows how to print the details of what fonts are present in a document.
        Document doc = new Document(getMyDir() + "Embedded font.docx");
        
        FontInfoCollection allFonts = doc.getFontInfos();
        
        // Print all the used and unused fonts in the document.
        for (int i = 0; i < allFonts.getCount(); i++) {
            System.out.println("Font index #{i}");
            System.out.println("\tName: {allFonts[i].Name}");
            System.out.println("\tIs {(allFonts[i].IsTrueType ? ");
        }
        See Also:
        FontInfoCollection, FontInfo
      • hasChildNodes

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

        Example:

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

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

        Example:

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

        public BuildingBlock getLastBuildingBlock()
        
        Gets the last building block in the glossary document. Returns null if there are no building blocks available.

        Example:

        Shows ways of accessing building blocks in a glossary document.
        public void glossaryDocument() throws Exception {
            Document doc = new Document();
            GlossaryDocument glossaryDoc = new GlossaryDocument();
        
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 1"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 2"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 3"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 4"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 5"));
        
            Assert.assertEquals(glossaryDoc.getBuildingBlocks().getCount(), 5);
        
            doc.setGlossaryDocument(glossaryDoc);
        
            // There are various ways of accessing building blocks.
            // 1 -  Get the first/last building blocks in the collection:
            Assert.assertEquals("Block 1", glossaryDoc.getFirstBuildingBlock().getName());
            Assert.assertEquals("Block 5", glossaryDoc.getLastBuildingBlock().getName());
        
            // 2 -  Get a building block by index:
            Assert.assertEquals("Block 2", glossaryDoc.getBuildingBlocks().get(1).getName());
            Assert.assertEquals("Block 3", glossaryDoc.getBuildingBlocks().toArray()[2].getName());
        
            // 3 -  Get the first building block that matches a gallery, name and category:
            Assert.assertEquals("Block 4",
                    glossaryDoc.getBuildingBlock(BuildingBlockGallery.ALL, "(Empty Category)", "Block 4").getName());
        
            // We will do that using a custom visitor,
            // which will give every BuildingBlock in the GlossaryDocument a unique GUID
            GlossaryDocVisitor visitor = new GlossaryDocVisitor();
            glossaryDoc.accept(visitor);
        
            System.out.println(visitor.getText());
        
            // When we open this document using Microsoft Word,
            // we can find the building blocks via Insert -> Quick Parts -> Building Blocks Organizer.
            doc.save(getArtifactsDir() + "BuildingBlocks.GlossaryDocument.dotx");
        }
        
        public static BuildingBlock createNewBuildingBlock(final GlossaryDocument glossaryDoc, final String buildingBlockName) {
            BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc);
            buildingBlock.setName(buildingBlockName);
        
            return buildingBlock;
        }
        
        /// <summary>
        /// Gives each building block in a visited glossary document a unique GUID, and stores the GUID-building block pairs in a dictionary.
        /// </summary>
        public static class GlossaryDocVisitor extends DocumentVisitor {
            public GlossaryDocVisitor() {
                mBlocksByGuid = new HashMap<>();
                mBuilder = new StringBuilder();
            }
        
            public String getText() {
                return mBuilder.toString();
            }
        
            public HashMap<UUID, BuildingBlock> getDictionary() {
                return mBlocksByGuid;
            }
        
            public int visitGlossaryDocumentStart(final GlossaryDocument glossary) {
                mBuilder.append("Glossary document found!\n");
                return VisitorAction.CONTINUE;
            }
        
            public int visitGlossaryDocumentEnd(final GlossaryDocument glossary) {
                mBuilder.append("Reached end of glossary!\n");
                mBuilder.append("BuildingBlocks found: " + mBlocksByGuid.size() + "\r\n");
                return VisitorAction.CONTINUE;
            }
        
            public int visitBuildingBlockStart(final BuildingBlock block) {
                block.setGuid(UUID.randomUUID());
                mBlocksByGuid.put(block.getGuid(), block);
                return VisitorAction.CONTINUE;
            }
        
            public int visitBuildingBlockEnd(final BuildingBlock block) {
                mBuilder.append("\tVisited block \"" + block.getName() + "\"" + "\r\n");
                mBuilder.append("\t Type: " + block.getType() + "\r\n");
                mBuilder.append("\t Gallery: " + block.getGallery() + "\r\n");
                mBuilder.append("\t Behavior: " + block.getBehavior() + "\r\n");
                mBuilder.append("\t Description: " + block.getDescription() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            private final HashMap<UUID, BuildingBlock> mBlocksByGuid;
            private final StringBuilder mBuilder;
        }
      • 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);
        
        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());
      • getLists

        public ListCollection getLists()
        
        Provides access to the list formatting used in the document.

        For more information see the description of the ListCollection class.

        Example:

        Shows how to specify list level number when building a list using DocumentBuilder.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create a numbered list based on one of the Microsoft Word list templates and
        // apply it to the current paragraph in the document builder
        builder.getListFormat().setList(doc.getLists().add(ListTemplate.NUMBER_ARABIC_DOT));
        
        // Insert text at each of the 9 indent levels
        for (int i = 0; i < 9; i++) {
            builder.getListFormat().setListLevelNumber(i);
            builder.writeln("Level " + i);
        }
        
        // Create a bulleted list based on one of the Microsoft Word list templates
        // and apply it to the current paragraph in the document builder
        builder.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DIAMONDS));
        
        for (int i = 0; i < 9; i++) {
            builder.getListFormat().setListLevelNumber(i);
            builder.writeln("Level " + i);
        }
        
        // This is a way to stop list formatting
        builder.getListFormat().setList(null);
        
        doc.save(getArtifactsDir() + "Lists.SpecifyListLevel.docx");
        See Also:
        ListCollection, List, ListFormat
      • getNextSibling

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

        Example:

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

        Example:

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

        public INodeChangingCallback getNodeChangingCallback() / public void setNodeChangingCallback(INodeChangingCallback value)
        
        Called when a node is inserted or removed in the document.

        Example:

        Shows how customize node changing with a callback.
        public void fontChangeViaCallback() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Set the node changing callback to custom implementation,
            // then add/remove nodes to get it to generate a log.
            HandleNodeChangingFontChanger callback = new HandleNodeChangingFontChanger();
            doc.setNodeChangingCallback(callback);
        
            builder.writeln("Hello world!");
            builder.writeln("Hello again!");
            builder.insertField(" HYPERLINK \"https://www.google.com/\" ");
            builder.insertShape(ShapeType.RECTANGLE, 300.0, 300.0);
        
            doc.getRange().getFields().get(0).remove();
        
            System.out.println(callback.getLog());
        }
        
        /// <summary>
        /// Logs the date and time of each node insertion and removal,
        /// and also set a custom font name/size for the text contents of Run nodes.
        /// </summary>
        public static class HandleNodeChangingFontChanger implements INodeChangingCallback {
            public void nodeInserted(NodeChangingArgs args) {
                mLog.append(MessageFormat.format("\tType:\t{0}", args.getNode().getNodeType()));
                mLog.append(MessageFormat.format("\tHash:\t{0}", args.getNode().hashCode()));
        
                if (args.getNode().getNodeType() == NodeType.RUN) {
                    Font font = ((Run) args.getNode()).getFont();
                    mLog.append(MessageFormat.format("\tFont:\tChanged from \"{0}\" {1}pt", font.getName(), font.getSize()));
        
                    font.setSize(24.0);
                    font.setName("Arial");
        
                    mLog.append(MessageFormat.format(" to \"{0}\" {1}pt", font.getName(), font.getSize()));
                    mLog.append(MessageFormat.format("\tContents:\n\t\t\"{0}\"", args.getNode().getText()));
                }
            }
        
            public void nodeInserting(NodeChangingArgs args) {
                mLog.append(MessageFormat.format("\n{0}\tNode insertion:", new Date()));
            }
        
            public void nodeRemoved(NodeChangingArgs args) {
                mLog.append(MessageFormat.format("\tType:\t{0}", args.getNode().getNodeType()));
                mLog.append(MessageFormat.format("\tHash code:\t{0}", args.getNode().hashCode()));
            }
        
            public void nodeRemoving(NodeChangingArgs args) {
                mLog.append(MessageFormat.format("\n{0}\tNode removal:", new Date()));
            }
        
            public String getLog() {
                return mLog.toString();
            }
        
            private final StringBuilder mLog = new StringBuilder();
        }
      • getNodeType

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

        Example:

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

        public java.awt.Color getPageColor() / public void setPageColor(java.awt.Color value)
        
        Gets or sets the page color of the document. This property is a simpler version of BackgroundShape.

        This property provides a simple way to specify a solid page color for the document. Setting this property creates and sets an appropriate BackgroundShape.

        If the page color is not set (e.g. there is no background shape in the document) returns a zero color.

        Example:

        Shows how to set the background color for all pages of a document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        doc.setPageColor(Color.lightGray);
        
        doc.save(getArtifactsDir() + "DocumentBase.SetPageColor.docx");
        See Also:
        BackgroundShape
      • getParentNode

        public CompositeNode getParentNode()
        
        Gets the immediate parent of this node.

        If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.

        Example:

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

        Example:

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

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

        Example:

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

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

        Example:

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

        public IResourceLoadingCallback getResourceLoadingCallback() / public void setResourceLoadingCallback(IResourceLoadingCallback value)
        
        Allows to control how external resources are loaded.

        Example:

        Shows how to customize the process of loading external resources into a document.
        public void resourceLoadingCallback() throws Exception {
            Document doc = new Document();
            doc.setResourceLoadingCallback(new ImageNameHandler());
        
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            // Images usually are inserted using a URI, or a byte array.
            // Every instance of a resource load will call our callback's ResourceLoading method.
            builder.insertImage("Google logo");
            builder.insertImage("Aspose logo");
            builder.insertImage("Watermark");
        
            Assert.assertEquals(3, doc.getChildNodes(NodeType.SHAPE, true).getCount());
        
            doc.save(getArtifactsDir() + "DocumentBase.ResourceLoadingCallback.docx");
        }
        
        /// <summary>
        /// Allows us to load images into a document using predefined shorthands, as opposed to URIs.
        /// This will separate image loading logic from the rest of the document construction.
        /// </summary>
        private static class ImageNameHandler implements IResourceLoadingCallback {
            public int resourceLoading(final ResourceLoadingArgs args) throws URISyntaxException, IOException {
                if (args.getResourceType() == ResourceType.IMAGE) {
                    // If this callback encounters one of the image shorthands while loading an image,
                    // it will apply unique logic for each defined shorthand instead of treating it as a URI.
                    if ("Google logo".equals(args.getOriginalUri())) {
                        args.setData(DocumentHelper.getBytesFromStream(new URI("http://www.google.com/images/logos/ps_logo2.png").toURL().openStream()));
        
                        return ResourceLoadingAction.USER_PROVIDED;
                    }
        
                    if ("Aspose logo".equals(args.getOriginalUri())) {
                        args.setData(DocumentHelper.getBytesFromStream(getAsposelogoUri().toURL().openStream()));
        
                        return ResourceLoadingAction.USER_PROVIDED;
                    }
        
                    if ("Watermark".equals(args.getOriginalUri())) {
                        InputStream imageStream = new FileInputStream(getImageDir() + "Transparent background logo.png");
                        args.setData(DocumentHelper.getBytesFromStream(imageStream));
        
                        return ResourceLoadingAction.USER_PROVIDED;
                    }
                }
        
                return ResourceLoadingAction.DEFAULT;
            }
        }
      • getStyles

        public StyleCollection getStyles()
        
        Returns a collection of styles defined in the document.

        For more information see the description of the StyleCollection class.

        Example:

        Shows how to access a document's style collection.
        Document doc = new Document();
        
        // A blank document comes with 4 styles by default
        Assert.assertEquals(4, doc.getStyles().getCount());
        
        Iterator<Style> stylesEnum = doc.getStyles().iterator();
        while (stylesEnum.hasNext()) {
            Style curStyle = stylesEnum.next();
            System.out.println(MessageFormat.format("Style name:\t\"{0}\", of type \"{1}\"", curStyle.getName(), curStyle.getType()));
            System.out.println(MessageFormat.format("\tSubsequent style:\t{0}", curStyle.getNextParagraphStyleName()));
            System.out.println(MessageFormat.format("\tIs heading:\t\t\t{0}", curStyle.isHeading()));
            System.out.println(MessageFormat.format("\tIs QuickStyle:\t\t{0}", curStyle.isQuickStyle()));
        
            Assert.assertEquals(curStyle.getDocument(), doc);
        }

        Example:

        Shows how to create and use a paragraph style with list formatting.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create a paragraph style and specify some formatting for it
        Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1");
        style.getFont().setSize(24.0);
        style.getFont().setName("Verdana");
        style.getParagraphFormat().setSpaceAfter(12.0);
        
        // Create a list and make sure the paragraphs that use this style will use this list
        style.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DEFAULT));
        style.getListFormat().setListLevelNumber(0);
        
        // Apply the paragraph style to the current paragraph in the document and add some text
        builder.getParagraphFormat().setStyle(style);
        builder.writeln("Hello World: MyStyle1, bulleted list.");
        
        // Change to a paragraph style that has no list formatting
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
        builder.writeln("Hello World: Normal.");
        
        builder.getDocument().save(getArtifactsDir() + "Styles.ParagraphStyleBulletedList.docx");
        See Also:
        StyleCollection, Style
      • getWarningCallback/setWarningCallback

        public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
        
        Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss. Document may generate warnings at any stage of its existence, so it's important to setup warning callback as early as possible to avoid the warnings loss. E.g. such properties as Document.PageCount actually build the document layout which is used later for rendering, and the layout warnings may be lost if warning callback is specified just for the rendering calls later.
    • 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.visitGlossaryDocumentStart(com.aspose.words.GlossaryDocument), then calls accept(com.aspose.words.DocumentVisitor) for all child nodes of this node and then calls DocumentVisitor.visitGlossaryDocumentEnd(com.aspose.words.GlossaryDocument) at the end.

        Note: A glossary document node and its children are not visited when you execute a Visitor over a Document. If you want to execute a Visitor over a glossary document, you need to call accept(com.aspose.words.DocumentVisitor).

        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:

        Shows ways of accessing building blocks in a glossary document.
        public void glossaryDocument() throws Exception {
            Document doc = new Document();
            GlossaryDocument glossaryDoc = new GlossaryDocument();
        
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 1"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 2"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 3"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 4"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 5"));
        
            Assert.assertEquals(glossaryDoc.getBuildingBlocks().getCount(), 5);
        
            doc.setGlossaryDocument(glossaryDoc);
        
            // There are various ways of accessing building blocks.
            // 1 -  Get the first/last building blocks in the collection:
            Assert.assertEquals("Block 1", glossaryDoc.getFirstBuildingBlock().getName());
            Assert.assertEquals("Block 5", glossaryDoc.getLastBuildingBlock().getName());
        
            // 2 -  Get a building block by index:
            Assert.assertEquals("Block 2", glossaryDoc.getBuildingBlocks().get(1).getName());
            Assert.assertEquals("Block 3", glossaryDoc.getBuildingBlocks().toArray()[2].getName());
        
            // 3 -  Get the first building block that matches a gallery, name and category:
            Assert.assertEquals("Block 4",
                    glossaryDoc.getBuildingBlock(BuildingBlockGallery.ALL, "(Empty Category)", "Block 4").getName());
        
            // We will do that using a custom visitor,
            // which will give every BuildingBlock in the GlossaryDocument a unique GUID
            GlossaryDocVisitor visitor = new GlossaryDocVisitor();
            glossaryDoc.accept(visitor);
        
            System.out.println(visitor.getText());
        
            // When we open this document using Microsoft Word,
            // we can find the building blocks via Insert -> Quick Parts -> Building Blocks Organizer.
            doc.save(getArtifactsDir() + "BuildingBlocks.GlossaryDocument.dotx");
        }
        
        public static BuildingBlock createNewBuildingBlock(final GlossaryDocument glossaryDoc, final String buildingBlockName) {
            BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc);
            buildingBlock.setName(buildingBlockName);
        
            return buildingBlock;
        }
        
        /// <summary>
        /// Gives each building block in a visited glossary document a unique GUID, and stores the GUID-building block pairs in a dictionary.
        /// </summary>
        public static class GlossaryDocVisitor extends DocumentVisitor {
            public GlossaryDocVisitor() {
                mBlocksByGuid = new HashMap<>();
                mBuilder = new StringBuilder();
            }
        
            public String getText() {
                return mBuilder.toString();
            }
        
            public HashMap<UUID, BuildingBlock> getDictionary() {
                return mBlocksByGuid;
            }
        
            public int visitGlossaryDocumentStart(final GlossaryDocument glossary) {
                mBuilder.append("Glossary document found!\n");
                return VisitorAction.CONTINUE;
            }
        
            public int visitGlossaryDocumentEnd(final GlossaryDocument glossary) {
                mBuilder.append("Reached end of glossary!\n");
                mBuilder.append("BuildingBlocks found: " + mBlocksByGuid.size() + "\r\n");
                return VisitorAction.CONTINUE;
            }
        
            public int visitBuildingBlockStart(final BuildingBlock block) {
                block.setGuid(UUID.randomUUID());
                mBlocksByGuid.put(block.getGuid(), block);
                return VisitorAction.CONTINUE;
            }
        
            public int visitBuildingBlockEnd(final BuildingBlock block) {
                mBuilder.append("\tVisited block \"" + block.getName() + "\"" + "\r\n");
                mBuilder.append("\t Type: " + block.getType() + "\r\n");
                mBuilder.append("\t Gallery: " + block.getGallery() + "\r\n");
                mBuilder.append("\t Behavior: " + block.getBehavior() + "\r\n");
                mBuilder.append("\t Description: " + block.getDescription() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            private final HashMap<UUID, BuildingBlock> mBlocksByGuid;
            private final StringBuilder mBuilder;
        }
      • appendChild

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

        public Node deepClone(boolean isCloneChildren)
        Creates a duplicate of the node.

        This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.

        This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.

        Parameters:
        isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.
        Returns:
        The cloned node.

        Example:

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

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

        Example:

        Shows how to find out if a table contains another table or if the table itself is nested inside another table.
        public void calculateDepthOfNestedTables() throws Exception {
            Document doc = new Document(getMyDir() + "Nested tables.docx");
            NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
        
            for (int i = 0; i < tables.getCount(); i++) {
                // First lets find if any cells in the table have tables themselves as children
                int count = getChildTableCount((Table) tables.get(i));
                System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count));
        
                // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth
                int tableDepth = getNestedDepthOfTable((Table) tables.get(i));
        
                if (tableDepth > 0)
                    System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth));
                else
                    System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i));
            }
        }
        
        /**
         * Calculates what level a table is nested inside other tables.
         *
         * @returns An integer containing the level the table is nested at.
         * 0 = Table is not nested inside any other table
         * 1 = Table is nested within one parent table
         * 2 = Table is nested within two parent tables etc..
         */
        private static int getNestedDepthOfTable(final Table table) {
            int depth = 0;
        
            int type = table.getNodeType();
            // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table
            Node parent = table.getAncestor(table.getNodeType());
        
            while (parent != null) {
                // Every time we find a table a level up we increase the depth counter and then try to find an
                // ancestor of type table from the parent
                depth++;
                parent = parent.getAncestor(Table.class);
            }
        
            return depth;
        }
        
        /**
         * Determines if a table contains any immediate child table within its cells.
         * Does not recursively traverse through those tables to check for further tables.
         *
         * @returns Returns true if at least one child cell contains a table.
         * Returns false if no cells in the table contains a table.
         */
        private static int getChildTableCount(final Table table) {
            int tableCount = 0;
            // Iterate through all child rows in the table
            for (Row row : table.getRows()) {
                // Iterate through all child cells in the row
                for (Cell cell : row.getCells()) {
                    // Retrieve the collection of child tables of this cell
                    TableCollection childTables = cell.getTables();
        
                    // If this cell has a table as a child then return true
                    if (childTables.getCount() > 0) tableCount++;
                }
            }
        
            // No cell contains a table
            return tableCount;
        }
      • getAncestor

        public CompositeNode getAncestor(java.lang.Class ancestorType)
        Gets the first ancestor of the specified object type.

        The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

        Parameters:
        ancestorType - The object type of the ancestor to retrieve.
        Returns:
        The ancestor of the specified type or null if no ancestor of this type was found.

        Example:

        Shows how to find out if a table contains another table or if the table itself is nested inside another table.
        public void calculateDepthOfNestedTables() throws Exception {
            Document doc = new Document(getMyDir() + "Nested tables.docx");
            NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
        
            for (int i = 0; i < tables.getCount(); i++) {
                // First lets find if any cells in the table have tables themselves as children
                int count = getChildTableCount((Table) tables.get(i));
                System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count));
        
                // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth
                int tableDepth = getNestedDepthOfTable((Table) tables.get(i));
        
                if (tableDepth > 0)
                    System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth));
                else
                    System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i));
            }
        }
        
        /**
         * Calculates what level a table is nested inside other tables.
         *
         * @returns An integer containing the level the table is nested at.
         * 0 = Table is not nested inside any other table
         * 1 = Table is nested within one parent table
         * 2 = Table is nested within two parent tables etc..
         */
        private static int getNestedDepthOfTable(final Table table) {
            int depth = 0;
        
            int type = table.getNodeType();
            // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table
            Node parent = table.getAncestor(table.getNodeType());
        
            while (parent != null) {
                // Every time we find a table a level up we increase the depth counter and then try to find an
                // ancestor of type table from the parent
                depth++;
                parent = parent.getAncestor(Table.class);
            }
        
            return depth;
        }
        
        /**
         * Determines if a table contains any immediate child table within its cells.
         * Does not recursively traverse through those tables to check for further tables.
         *
         * @returns Returns true if at least one child cell contains a table.
         * Returns false if no cells in the table contains a table.
         */
        private static int getChildTableCount(final Table table) {
            int tableCount = 0;
            // Iterate through all child rows in the table
            for (Row row : table.getRows()) {
                // Iterate through all child cells in the row
                for (Cell cell : row.getCells()) {
                    // Retrieve the collection of child tables of this cell
                    TableCollection childTables = cell.getTables();
        
                    // If this cell has a table as a child then return true
                    if (childTables.getCount() > 0) tableCount++;
                }
            }
        
            // No cell contains a table
            return tableCount;
        }
      • getBuildingBlock

        public BuildingBlock getBuildingBlock(int gallery, java.lang.String category, java.lang.String name)
        Finds a building block using the specified gallery, category and name.

        This is a convenience method that iterates over all building blocks in this collection and returns the first building block that matches the specified gallery, category and name.

        Microsoft Word organizes building blocks into galleries. The galleries are predefined using the BuildingBlockGallery enum. Within each gallery, building blocks can be organized into one or more categories. The category name is a string. Each building block has a name. A building block name is not guaranteed to be unique.

        Parameters:
        gallery - A BuildingBlockGallery value. The gallery criteria.
        category - The category criteria. Can be null, in which case it will not be used for comparison.
        name - The building block name criteria.
        Returns:
        The matching building block or null if a match was not found.

        Example:

        Shows ways of accessing building blocks in a glossary document.
        public void glossaryDocument() throws Exception {
            Document doc = new Document();
            GlossaryDocument glossaryDoc = new GlossaryDocument();
        
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 1"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 2"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 3"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 4"));
            glossaryDoc.appendChild(createNewBuildingBlock(glossaryDoc, "Block 5"));
        
            Assert.assertEquals(glossaryDoc.getBuildingBlocks().getCount(), 5);
        
            doc.setGlossaryDocument(glossaryDoc);
        
            // There are various ways of accessing building blocks.
            // 1 -  Get the first/last building blocks in the collection:
            Assert.assertEquals("Block 1", glossaryDoc.getFirstBuildingBlock().getName());
            Assert.assertEquals("Block 5", glossaryDoc.getLastBuildingBlock().getName());
        
            // 2 -  Get a building block by index:
            Assert.assertEquals("Block 2", glossaryDoc.getBuildingBlocks().get(1).getName());
            Assert.assertEquals("Block 3", glossaryDoc.getBuildingBlocks().toArray()[2].getName());
        
            // 3 -  Get the first building block that matches a gallery, name and category:
            Assert.assertEquals("Block 4",
                    glossaryDoc.getBuildingBlock(BuildingBlockGallery.ALL, "(Empty Category)", "Block 4").getName());
        
            // We will do that using a custom visitor,
            // which will give every BuildingBlock in the GlossaryDocument a unique GUID
            GlossaryDocVisitor visitor = new GlossaryDocVisitor();
            glossaryDoc.accept(visitor);
        
            System.out.println(visitor.getText());
        
            // When we open this document using Microsoft Word,
            // we can find the building blocks via Insert -> Quick Parts -> Building Blocks Organizer.
            doc.save(getArtifactsDir() + "BuildingBlocks.GlossaryDocument.dotx");
        }
        
        public static BuildingBlock createNewBuildingBlock(final GlossaryDocument glossaryDoc, final String buildingBlockName) {
            BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc);
            buildingBlock.setName(buildingBlockName);
        
            return buildingBlock;
        }
        
        /// <summary>
        /// Gives each building block in a visited glossary document a unique GUID, and stores the GUID-building block pairs in a dictionary.
        /// </summary>
        public static class GlossaryDocVisitor extends DocumentVisitor {
            public GlossaryDocVisitor() {
                mBlocksByGuid = new HashMap<>();
                mBuilder = new StringBuilder();
            }
        
            public String getText() {
                return mBuilder.toString();
            }
        
            public HashMap<UUID, BuildingBlock> getDictionary() {
                return mBlocksByGuid;
            }
        
            public int visitGlossaryDocumentStart(final GlossaryDocument glossary) {
                mBuilder.append("Glossary document found!\n");
                return VisitorAction.CONTINUE;
            }
        
            public int visitGlossaryDocumentEnd(final GlossaryDocument glossary) {
                mBuilder.append("Reached end of glossary!\n");
                mBuilder.append("BuildingBlocks found: " + mBlocksByGuid.size() + "\r\n");
                return VisitorAction.CONTINUE;
            }
        
            public int visitBuildingBlockStart(final BuildingBlock block) {
                block.setGuid(UUID.randomUUID());
                mBlocksByGuid.put(block.getGuid(), block);
                return VisitorAction.CONTINUE;
            }
        
            public int visitBuildingBlockEnd(final BuildingBlock block) {
                mBuilder.append("\tVisited block \"" + block.getName() + "\"" + "\r\n");
                mBuilder.append("\t Type: " + block.getType() + "\r\n");
                mBuilder.append("\t Gallery: " + block.getGallery() + "\r\n");
                mBuilder.append("\t Behavior: " + block.getBehavior() + "\r\n");
                mBuilder.append("\t Description: " + block.getDescription() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            private final HashMap<UUID, BuildingBlock> mBlocksByGuid;
            private final StringBuilder mBuilder;
        }
      • 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 traverse through a composite node's collection of child nodes.
        Document doc = new Document();
        
        // Add two runs and one shape as child nodes to the first paragraph of this document.
        Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
        paragraph.appendChild(new Run(doc, "Hello world! "));
        
        Shape shape = new Shape(doc, ShapeType.RECTANGLE);
        shape.setWidth(200.0);
        shape.setHeight(200.0);
        shape.setWrapType(WrapType.INLINE);
        paragraph.appendChild(shape);
        
        paragraph.appendChild(new Run(doc, "Hello again!"));
        
        // Iterate through the paragraph's collection of immediate children,
        // and print any runs or shapes that we find within.
        NodeCollection children = paragraph.getChildNodes();
        
        Assert.assertEquals(3, paragraph.getChildNodes().getCount());
        
        for (Node child : (Iterable<Node>) children)
            switch (child.getNodeType()) {
                case NodeType.RUN:
                    System.out.println("Run contents:");
                    System.out.println("\t\"{child.GetText().Trim()}\"");
                    break;
                case NodeType.SHAPE:
                    Shape childShape = (Shape) child;
                    System.out.println("Shape:");
                    System.out.println("\t{childShape.ShapeType}, {childShape.Width}x{childShape.Height}");
                    break;
            }

        Example:

        Shows how to apply attributes of a table's style directly to the table's elements.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Hello world!");
        builder.endTable();
        
        TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
        tableStyle.setRowStripe(3);
        tableStyle.setCellSpacing(5.0);
        tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
        tableStyle.getBorders().setColor(Color.BLUE);
        tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
        
        table.setStyle(tableStyle);
        
        // This method concerns table style attributes such as the ones we set above.
        doc.expandTableStylesToDirectFormatting();
        
        doc.save(getArtifactsDir() + "Document.TableStyleToDirectFormatting.docx");
      • 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 extract images from a document, and save them to the local file system as individual files.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        // Get the collection of shapes from the document,
        // and save the image data of every shape with an image as a file to the local file system.
        NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
        
        int imageIndex = 0;
        for (Shape shape : (Iterable<Shape>) shapes) {
            if (shape.hasImage()) {
                // The image data of shapes may contain images of many possible image formats. 
                // We can determine a file extension for each image automatically, based on its format.
                String imageFileName = MessageFormat.format("File.ExtractImages.{0}{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
                shape.getImageData().save(getArtifactsDir() + imageFileName);
                imageIndex++;
            }
        }

        Example:

        Shows how to print all of a document's comments and their replies.
        Document doc = new Document(getMyDir() + "Comments.docx");
        
        NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
        
        // If a comment has no ancestor, it is a "top-level" comment as opposed to a reply-type comment.
        // Print all top-level comments along with their replies, if there are any.
        for (Comment comment : (Iterable<Comment>) comments) {
            if (comment.getAncestor() == null) {
                System.out.println("Top-level comment:");
                System.out.println("\t\"{comment.GetText().Trim()}\", by {comment.Author}");
                System.out.println("Has {comment.Replies.Count} replies");
                for (Comment commentReply : comment.getReplies()) {
                    System.out.println("\t\"{commentReply.GetText().Trim()}\", by {commentReply.Author}");
                }
                System.out.println();
            }
        }
      • getText

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

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

        Example:

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

        Example:

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

        public Node importNode(Node srcNode, boolean isImportChildren)

        Imports a node from another document to the current document.

        This method uses the ImportFormatMode.USE_DESTINATION_STYLES option to resolve formatting.

        Importing a node creates a copy of the source node belonging to the importing document. The returned node has no parent. The source node is not altered or removed from the original document.

        Before a node from another document can be inserted into this document, it must be imported. During import, document-specific properties such as references to styles and lists are translated from the original to the importing document. After the node was imported, it can be inserted into the appropriate place in the document using insertBefore(com.aspose.words.Node,com.aspose.words.Node) or insertAfter(com.aspose.words.Node,com.aspose.words.Node).

        If the source node already belongs to the destination document, then simply a deep clone of the source node is created.

        Parameters:
        srcNode - The node being imported.
        isImportChildren - True to import all child nodes recursively; otherwise, false.
        Returns:
        The cloned node that belongs to the current document.
        See Also:
        NodeImporter

        Example:

        Shows how to import a node from one document to another.
        Document srcDoc = new Document();
        Document dstDoc = new Document();
        
        srcDoc.getFirstSection().getBody().getFirstParagraph().appendChild(
                new Run(srcDoc, "Source document first paragraph text."));
        dstDoc.getFirstSection().getBody().getFirstParagraph().appendChild(
                new Run(dstDoc, "Destination document first paragraph text."));
        
        // Every node has a parent document, which is the document that contains the node.
        // Inserting a node into a document that the node does not belong to will throw an exception.
        Assert.assertNotEquals(dstDoc, srcDoc.getFirstSection().getDocument());
        Assert.assertThrows(IllegalArgumentException.class, () -> dstDoc.appendChild(srcDoc.getFirstSection()));
        
        // Use the ImportNode method to create a copy of a node, which will have the document
        // that called the ImportNode method set as its new owner document.
        Section importedSection = (Section) dstDoc.importNode(srcDoc.getFirstSection(), true);
        
        Assert.assertEquals(dstDoc, importedSection.getDocument());
        
        // We can now insert the node into the document.
        dstDoc.appendChild(importedSection);
        
        Assert.assertEquals("Destination document first paragraph text.\r\nSource document first paragraph text.\r\n",
                dstDoc.toString(SaveFormat.TEXT));
      • importNode

        public Node importNode(Node srcNode, boolean isImportChildren, int importFormatMode)

        Imports a node from another document to the current document with an option to control formatting.

        This overload is useful to control how styles and list formatting are imported.

        Importing a node creates a copy of the source node belonging to the importing document. The returned node has no parent. The source node is not altered or removed from the original document.

        Before a node from another document can be inserted into this document, it must be imported. During import, document-specific properties such as references to styles and lists are translated from the original to the importing document. After the node was imported, it can be inserted into the appropriate place in the document using insertBefore(com.aspose.words.Node,com.aspose.words.Node) or insertAfter(com.aspose.words.Node,com.aspose.words.Node).

        If the source node already belongs to the destination document, then simply a deep clone of the source node is created.

        Parameters:
        srcNode - The node to imported.
        isImportChildren - True to import all child nodes recursively; otherwise, false.
        importFormatMode - A ImportFormatMode value. Specifies how to merge style formatting that clashes.
        Returns:
        The cloned, imported node. The node belongs to the destination document, but has no parent.
        See Also:
        ImportFormatMode, NodeImporter

        Example:

        Shows how to import node from source document to destination document with specific options.
        // Create two documents, and add a character style to each document.
        // Configure the styles to have the same name, but different text formatting.
        Document srcDoc = new Document();
        Style srcStyle = srcDoc.getStyles().add(StyleType.CHARACTER, "My style");
        srcStyle.getFont().setName("Courier New");
        DocumentBuilder srcBuilder = new DocumentBuilder(srcDoc);
        srcBuilder.getFont().setStyle(srcStyle);
        srcBuilder.writeln("Source document text.");
        
        Document dstDoc = new Document();
        Style dstStyle = dstDoc.getStyles().add(StyleType.CHARACTER, "My style");
        dstStyle.getFont().setName("Calibri");
        DocumentBuilder dstBuilder = new DocumentBuilder(dstDoc);
        dstBuilder.getFont().setStyle(dstStyle);
        dstBuilder.writeln("Destination document text.");
        
        // Import the Section from the destination document into the source document, causing a style name collision.
        // If we use destination styles, then the imported source text with the same style name
        // as destination text will adopt the destination style.
        Section importedSection = (Section) dstDoc.importNode(srcDoc.getFirstSection(), true, ImportFormatMode.USE_DESTINATION_STYLES);
        Assert.assertEquals(dstStyle.getFont().getName(), importedSection.getBody().getFirstParagraph().getRuns().get(0).getFont().getName());
        Assert.assertEquals(dstStyle.getName(), importedSection.getBody().getFirstParagraph().getRuns().get(0).getFont().getStyleName());
        
        // If we use ImportFormatMode.KeepDifferentStyles, the source style is preserved,
        // and the naming clash resolves by adding a suffix.
        dstDoc.importNode(srcDoc.getFirstSection(), true, ImportFormatMode.KEEP_DIFFERENT_STYLES);
        Assert.assertEquals(dstStyle.getFont().getName(), dstDoc.getStyles().get("My style").getFont().getName());
        Assert.assertEquals(srcStyle.getFont().getName(), dstDoc.getStyles().get("My style_0").getFont().getName());
      • 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");
        
        Body body = doc.getFirstSection().getBody();
        
        // Retrieve the index of the last paragraph in the body of the first section.
        Assert.assertEquals(24, body.getChildNodes().indexOf(body.getLastParagraph()));
      • insertAfter

        public Node insertAfter(Node newChild, Node refChild)
                        throws java.lang.Exception
        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 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 add, update and delete child nodes in a CompositeNode's collection of children.
        Document doc = new Document();
        
        // An empty document, by default, has one paragraph.
        Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
        
        // Composite nodes such as our paragraph can contain other composite and inline nodes as children.
        Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
        Run paragraphText = new Run(doc, "Initial text. ");
        paragraph.appendChild(paragraphText);
        
        // Create three more run nodes.
        Run run1 = new Run(doc, "Run 1. ");
        Run run2 = new Run(doc, "Run 2. ");
        Run run3 = new Run(doc, "Run 3. ");
        
        // The document body will not display these runs until we insert them into a composite node
        // that itself is a part of the document's node tree, as we did with the first run.
        // We can determine where the text contents of nodes that we insert
        // appears in the document by specifying an insertion location relative to another node in the paragraph.
        Assert.assertEquals("Initial text.", paragraph.getText().trim());
        
        // Insert the second run into the paragraph in front of the initial run.
        paragraph.insertBefore(run2, paragraphText);
        
        Assert.assertEquals("Run 2. Initial text.", paragraph.getText().trim());
        
        // Insert the third run after the initial run.
        paragraph.insertAfter(run3, paragraphText);
        
        Assert.assertEquals("Run 2. Initial text. Run 3.", paragraph.getText().trim());
        
        // Insert the first run to the start of the paragraph's child nodes collection.
        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());
        
        // We can modify the contents of the run by editing and deleting existing child nodes.
        ((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());

        Example:

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

        public Node insertBefore(Node newChild, Node refChild)
                         throws java.lang.Exception
        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 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 in a CompositeNode's collection of children.
        Document doc = new Document();
        
        // An empty document, by default, has one paragraph.
        Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
        
        // Composite nodes such as our paragraph can contain other composite and inline nodes as children.
        Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
        Run paragraphText = new Run(doc, "Initial text. ");
        paragraph.appendChild(paragraphText);
        
        // Create three more run nodes.
        Run run1 = new Run(doc, "Run 1. ");
        Run run2 = new Run(doc, "Run 2. ");
        Run run3 = new Run(doc, "Run 3. ");
        
        // The document body will not display these runs until we insert them into a composite node
        // that itself is a part of the document's node tree, as we did with the first run.
        // We can determine where the text contents of nodes that we insert
        // appears in the document by specifying an insertion location relative to another node in the paragraph.
        Assert.assertEquals("Initial text.", paragraph.getText().trim());
        
        // Insert the second run into the paragraph in front of the initial run.
        paragraph.insertBefore(run2, paragraphText);
        
        Assert.assertEquals("Run 2. Initial text.", paragraph.getText().trim());
        
        // Insert the third run after the initial run.
        paragraph.insertAfter(run3, paragraphText);
        
        Assert.assertEquals("Run 2. Initial text. Run 3.", paragraph.getText().trim());
        
        // Insert the first run to the start of the paragraph's child nodes collection.
        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());
        
        // We can modify the contents of the run by editing and deleting existing child nodes.
        ((Run)paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
        paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);
        
        Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
        Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());
      • iterator

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

        Example:

        Shows how to traverse through a composite node's collection of child nodes.
        Document doc = new Document();
        
        // Add two runs and one shape as child nodes to the first paragraph of this document.
        Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
        paragraph.appendChild(new Run(doc, "Hello world! "));
        
        Shape shape = new Shape(doc, ShapeType.RECTANGLE);
        shape.setWidth(200.0);
        shape.setHeight(200.0);
        shape.setWrapType(WrapType.INLINE);
        paragraph.appendChild(shape);
        
        paragraph.appendChild(new Run(doc, "Hello again!"));
        
        // Iterate through the paragraph's collection of immediate children,
        // and print any runs or shapes that we find within.
        NodeCollection children = paragraph.getChildNodes();
        
        Assert.assertEquals(3, paragraph.getChildNodes().getCount());
        
        for (Node child : (Iterable<Node>) children)
            switch (child.getNodeType()) {
                case NodeType.RUN:
                    System.out.println("Run contents:");
                    System.out.println("\t\"{child.GetText().Trim()}\"");
                    break;
                case NodeType.SHAPE:
                    Shape childShape = (Shape) child;
                    System.out.println("Shape:");
                    System.out.println("\t{childShape.ShapeType}, {childShape.Width}x{childShape.Height}");
                    break;
            }
      • 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.
      • prependChild

        public Node prependChild(Node newChild)
                         throws java.lang.Exception
        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 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 in a CompositeNode's collection of children.
        Document doc = new Document();
        
        // An empty document, by default, has one paragraph.
        Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
        
        // Composite nodes such as our paragraph can contain other composite and inline nodes as children.
        Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
        Run paragraphText = new Run(doc, "Initial text. ");
        paragraph.appendChild(paragraphText);
        
        // Create three more run nodes.
        Run run1 = new Run(doc, "Run 1. ");
        Run run2 = new Run(doc, "Run 2. ");
        Run run3 = new Run(doc, "Run 3. ");
        
        // The document body will not display these runs until we insert them into a composite node
        // that itself is a part of the document's node tree, as we did with the first run.
        // We can determine where the text contents of nodes that we insert
        // appears in the document by specifying an insertion location relative to another node in the paragraph.
        Assert.assertEquals("Initial text.", paragraph.getText().trim());
        
        // Insert the second run into the paragraph in front of the initial run.
        paragraph.insertBefore(run2, paragraphText);
        
        Assert.assertEquals("Run 2. Initial text.", paragraph.getText().trim());
        
        // Insert the third run after the initial run.
        paragraph.insertAfter(run3, paragraphText);
        
        Assert.assertEquals("Run 2. Initial text. Run 3.", paragraph.getText().trim());
        
        // Insert the first run to the start of the paragraph's child nodes collection.
        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());
        
        // We can modify the contents of the run by editing and deleting existing child nodes.
        ((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.
      • remove

        public void remove()
        Removes itself from the parent.

        Example:

        Shows how to remove all child nodes of a specific type from a composite node.
        Document doc = new Document(getMyDir() + "Tables.docx");
        
        Assert.assertEquals(2, doc.getChildNodes(NodeType.TABLE, true).getCount());
        
        Node curNode = doc.getFirstSection().getBody().getFirstChild();
        
        while (curNode != null) {
            // Save the next sibling node as a variable in case we want to move to it after deleting this node.
            Node nextNode = curNode.getNextSibling();
        
            // A section body can contain Paragraph and Table nodes.
            // If the node is a Table, remove it from the parent.
            if (curNode.getNodeType() == NodeType.TABLE) {
                curNode.remove();
            }
        
            curNode = nextNode;
        }
        
        Assert.assertEquals(0, doc.getChildNodes(NodeType.TABLE, true).getCount());
      • removeAllChildren

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

        Example:

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

        Example:

        Removes all smart tags from descendant nodes of a composite node.
        Document doc = new Document(getMyDir() + "Smart tags.doc");
        
        Assert.assertEquals(8, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
        
        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.
        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.
        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 use an XPath expression to test whether a node is inside a field.
        Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx");
        
        // The NodeList that results from this XPath expression will contain all nodes we find inside a field.
        // However, FieldStart and FieldEnd nodes can be on 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.
        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.
        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");
        
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When we call the ToString method using the html SaveFormat overload,
        // it converts the node's contents to their raw html representation.
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(SaveFormat.HTML));
        
        // We can also modify the result of this conversion using a SaveOptions object.
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setExportRelativeFontSize(true);
        
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(saveOptions));
      • toString

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

        Example:

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

        Example:

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