com.aspose.words

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

Represents a table in a Word document.

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

Table can contain one or more Row nodes.

A minimal valid table needs to have at least one Row.

Example:

Shows how to remove all borders from a table.
Document doc = new Document(getMyDir() + "Table.Document.doc");

// Remove all borders from the first table in the document.
Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);

// Clear the borders all cells in the table.
table.clearBorders();

doc.save(getMyDir() + "\\Artifacts\\Table.ClearBorders.doc");

Example:

Shows how to combine the rows from two tables into one.
// Load the document.
Document doc = new Document(getMyDir() + "Table.Document.doc");

// 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(getMyDir() + "\\Artifacts\\Table.CombineTables.doc");

Example:

Shows how to build a formatted table that contains 2 rows and 2 columns.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Table table = builder.startTable();

// Insert a cell
builder.insertCell();
// Use fixed column widths.
table.autoFit(AutoFitBehavior.FIXED_COLUMN_WIDTHS);

builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER);
builder.write("This is row 1 cell 1");

// Insert a cell
builder.insertCell();
builder.write("This is row 1 cell 2");

builder.endRow();

// Insert a cell
builder.insertCell();

// Apply new row formatting
builder.getRowFormat().setHeight(100);
builder.getRowFormat().setHeightRule(HeightRule.EXACTLY);

builder.getCellFormat().setOrientation(TextOrientation.UPWARD);
builder.writeln("This is row 2 cell 1");

// Insert a cell
builder.insertCell();
builder.getCellFormat().setOrientation(TextOrientation.DOWNWARD);
builder.writeln("This is row 2 cell 2");

builder.endRow();

builder.endTable();

Example:

Shows how to build a nested table without using DocumentBuilder.
public void nestedTablesUsingNodeConstructors() throws Exception
{
    Document doc = new Document();

    // Create the outer table with three rows and four columns.
    Table outerTable = createTable(doc, 3, 4, "Outer Table");
    // Add it to the document body.
    doc.getFirstSection().getBody().appendChild(outerTable);

    // Create another table with two rows and two columns.
    Table innerTable = createTable(doc, 2, 2, "Inner Table");
    // Add this table to the first cell of the outer table.
    outerTable.getFirstRow().getFirstCell().appendChild(innerTable);

    doc.save(getMyDir() + "\\Artifacts\\Table.CreateNestedTable.doc");

}

/**
 * Creates a new table in the document with the given dimensions and text in each cell.
 */
private Table createTable(Document doc, int rowCount, int cellCount, String cellText)
{
    Table table = new Table(doc);

    // Create the specified number of rows.
    for (int rowId = 1; rowId <= rowCount; rowId++)
    {
        Row row = new Row(doc);
        table.appendChild(row);

        // Create the specified number of cells for each row.
        for (int cellId = 1; cellId <= cellCount; cellId++)
        {
            Cell cell = new Cell(doc);
            row.appendChild(cell);
            // Add a blank paragraph to the cell.
            cell.appendChild(new Paragraph(doc));

            // Add the text.
            cell.getFirstParagraph().appendChild(new Run(doc, cellText));
        }
    }

    return table;
}

Example:

Shows how to iterate through all tables in the document and display the content from each cell.
Document doc = new Document(getMyDir() + "Table.Document.doc");

// Here we get all tables from the Document node. You can do this for any other composite node
// which can contain block level nodes. For example you can retrieve tables from header or from a cell
// containing another table (nested tables).
NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);

// Iterate through all tables in the document
for (Table table : (Iterable<Table>) tables)
{
    // Get the index of the table node as contained in the parent node of the table
    int tableIndex = table.getParentNode().getChildNodes().indexOf(table);
    System.out.println(MessageFormat.format("Start of Table {0}", tableIndex));

    // Iterate through all rows in the table
    for (Row row : table.getRows())
    {
        int rowIndex = table.getRows().indexOf(row);
        System.out.println(MessageFormat.format("\tStart of Row {0}", rowIndex));

        // Iterate through all cells in the row
        for (Cell cell : row.getCells())
        {
            int cellIndex = row.getCells().indexOf(cell);
            // Get the plain text content of this cell.
            String cellText = cell.toString(SaveFormat.TEXT).trim();
            // Print the content of the cell.
            System.out.println(MessageFormat.format("\t\tContents of Cell:{0} = \"{1}\"", cellIndex, cellText));
        }
        //Console.WriteLine();
        System.out.println(MessageFormat.format("\tEnd of Row {0}", rowIndex));
    }
    System.out.println(MessageFormat.format("End of Table {0}", tableIndex));
    System.out.println();
}

Example:

Shows how to insert a table using the constructors of nodes.
Document doc = new Document();

// We start by creating the table object. Note how we must pass the document object
// to the constructor of each node. This is because every node we create must belong
// to some document.
Table table = new Table(doc);
// Add the table to the document.
doc.getFirstSection().getBody().appendChild(table);

// Here we could call EnsureMinimum to create the rows and cells for us. This method is used
// to ensure that the specified node is valid, in this case a valid table should have at least one
// row and one cell, therefore this method creates them for us.

// Instead we will handle creating the row and table ourselves. This would be the best way to do this
// if we were creating a table inside an algorthim for example.
Row row = new Row(doc);
row.getRowFormat().setAllowBreakAcrossPages(true);
table.appendChild(row);

// We can now apply any auto fit settings.
table.autoFit(AutoFitBehavior.FIXED_COLUMN_WIDTHS);

// Create a cell and add it to the row
Cell cell = new Cell(doc);
cell.getCellFormat().getShading().setBackgroundPatternColor(Color.BLUE);
cell.getCellFormat().setWidth(80);

// Add a paragraph to the cell as well as a new run with some text.
cell.appendChild(new Paragraph(doc));
cell.getFirstParagraph().appendChild(new Run(doc, "Row 1, Cell 1 Text"));

// Add the cell to the row.
row.appendChild(cell);

// We would then repeat the process for the other cells and rows in the table.
// We can also speed things up by cloning existing cells and rows.
row.appendChild(cell.deepClone(false));
row.getLastCell().appendChild(new Paragraph(doc));
row.getLastCell().getFirstParagraph().appendChild(new Run(doc, "Row 1, Cell 2 Text"));

doc.save(getMyDir() + "\\Artifacts\\Table.InsertTableUsingNodes.doc");

Constructor Summary
Table(DocumentBase doc)
Initializes a new instance of the Table class.
 
Property Getters/Setters Summary
doublegetAbsoluteHorizontalDistance()
Gets absolute horizontal floating table position specified by the table properties, in points. Default value is 0.
doublegetAbsoluteVerticalDistance()
Gets absolute vertical floating table position specified by the table properties, in points. Default value is 0.
intgetAlignment()
void
setAlignment(intvalue)
           Specifies how an inline table is aligned in the document. The value of the property is TableAlignment integer constant.
booleangetAllowAutoFit()
void
setAllowAutoFit(booleanvalue)
           Allows Microsoft Word and Aspose.Words to automatically resize cells in a table to fit their contents.
booleangetAllowCellSpacing()
void
setAllowCellSpacing(booleanvalue)
           Gets or sets the "Allow spacing between cells" option.
booleangetAllowOverlap()
Gets whether a floating table shall allow other floating objects in the document to overlap its extents when displayed. Default value is true.
booleangetBidi()
void
setBidi(booleanvalue)
           Gets or sets whether this is a right-to-left table.
doublegetBottomPadding()
void
setBottomPadding(doublevalue)
           Gets or sets the amount of space (in points) to add below the contents of cells.
doublegetCellSpacing()
void
setCellSpacing(doublevalue)
           Gets or sets the amount of space (in points) between the cells.
NodeCollectiongetChildNodes()
Gets all immediate child nodes of this node.
intgetCount()
Gets the number of immediate children of this node.
java.lang.StringgetDescription()
void
setDescription(java.lang.Stringvalue)
           Gets or sets description of this table. It provides an alternative text representation of the information contained in the table.
doublegetDistanceBottom()
Gets distance between table bottom and the surrounding text, in points.
doublegetDistanceLeft()
Gets distance between table left and the surrounding text, in points.
doublegetDistanceRight()
Gets distance between table right and the surrounding text, in points.
doublegetDistanceTop()
Gets distance between table top and the surrounding text, in points.
DocumentBasegetDocument()
Gets the document to which this node belongs.
NodegetFirstChild()
Gets the first child of the node.
RowgetFirstRow()
Returns the first Row node in the table.
booleanhasChildNodes()
Returns true if this node has any child nodes.
intgetHorizontalAnchor()
Gets the base object from which the horizontal positioning of floating table should be calculated. Default value is RelativeHorizontalPosition.COLUMN. The value of the property is RelativeHorizontalPosition integer constant.
booleanisComposite()
Returns true as this node can have child nodes.
NodegetLastChild()
Gets the last child of the node.
RowgetLastRow()
Returns the last Row node in the table.
doublegetLeftIndent()
void
setLeftIndent(doublevalue)
           Gets or sets the value that represents the left indent of the table.
doublegetLeftPadding()
void
setLeftPadding(doublevalue)
           Gets or sets the amount of space (in points) to add to the left of the contents of cells.
NodegetNextSibling()
Gets the node immediately following this node.
intgetNodeType()
Returns NodeType.Table. The value of the property is NodeType integer constant.
CompositeNodegetParentNode()
Gets the immediate parent of this node.
PreferredWidthgetPreferredWidth()
void
           Gets or sets the table preferred width.
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.
intgetRelativeHorizontalAlignment()
Gets floating table relative horizontal alignment. The value of the property is HorizontalAlignment integer constant.
intgetRelativeVerticalAlignment()
Gets floating table relative vertical alignment. The value of the property is VerticalAlignment integer constant.
doublegetRightPadding()
void
setRightPadding(doublevalue)
           Gets or sets the amount of space (in points) to add to the right of the contents of cells.
RowCollectiongetRows()
Provides typed access to the rows of the table.
StylegetStyle()
void
setStyle(Style value)
           Gets or sets the table style applied to this table.
intgetStyleIdentifier()
void
           Gets or sets the locale independent style identifier of the table style applied to this table. The value of the property is StyleIdentifier integer constant.
java.lang.StringgetStyleName()
void
setStyleName(java.lang.Stringvalue)
           Gets or sets the name of the table style applied to this table.
intgetStyleOptions()
void
setStyleOptions(intvalue)
           Gets or sets bit flags that specify how a table style is applied to this table. The value of the property is TableStyleOptions integer constant.
intgetTextWrapping()
void
setTextWrapping(intvalue)
           Gets or sets TextWrapping for table. The value of the property is TextWrapping integer constant.
java.lang.StringgetTitle()
void
setTitle(java.lang.Stringvalue)
           Gets or sets title of this table. It provides an alternative text representation of the information contained in the table.
doublegetTopPadding()
void
setTopPadding(doublevalue)
           Gets or sets the amount of space (in points) to add above the contents of cells.
intgetVerticalAnchor()
Gets the base object from which the vertical positioning of floating table should be calculated. Default value is RelativeVerticalPosition.MARGIN. The value of the property is RelativeVerticalPosition integer constant.
 
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.
voidautoFit(int behavior)
Resizes the table and cells according to the specified auto fit behavior.
voidclearBorders()
Removes all table and cell borders on this table.
voidclearShading()
Removes all shading on the table.
NodedeepClone(boolean isCloneChildren)
voidensureMinimum()
If the table has no rows, creates and appends one Row.
CompositeNodegetAncestor(int ancestorType)
Gets the first ancestor of the specified NodeType.
CompositeNodegetAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.
NodegetChild(int nodeType, int index, boolean isDeep)
Returns an Nth child node that matches the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep)
Returns a live collection of child nodes that match the specified type.
java.lang.StringgetText()
Gets the text of this node and of all its children.
intindexOf(Node child)
Returns the index of the specified child node in the child node array.
NodeinsertAfter(Node newChild, Node refChild)
Inserts the specified node immediately after the specified reference node.
NodeinsertBefore(Node newChild, Node refChild)
Inserts the specified node immediately before the specified reference node.
java.util.Iterator<Node>iterator()
Provides support for the for each style iteration over the child nodes of this node.
NodenextPreOrder(Node rootNode)
Gets next node according to the pre-order tree traversal algorithm.
NodeprependChild(Node newChild)
Adds the specified node to the beginning of the list of child nodes for this node.
NodepreviousPreOrder(Node rootNode)
Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()
Removes itself from the parent.
voidremoveAllChildren()
Removes all the child nodes of the current node.
NoderemoveChild(Node oldChild)
Removes the specified child node.
voidremoveSmartTags()
Removes all SmartTag descendant nodes of the current node.
NodeListselectNodes(java.lang.String xpath)
Selects a list of nodes matching the XPath expression.
NodeselectSingleNode(java.lang.String xpath)
Selects the first Node that matches the XPath expression.
voidsetBorder(int borderType, int lineStyle, double lineWidth, java.awt.Color color, boolean isOverrideCellBorders)
Sets the specified table border to the specified line style, width and color.
voidsetBorders(int lineStyle, double lineWidth, java.awt.Color color)
Sets all table borders to the specified line style, width and color.
voidsetShading(int texture, java.awt.Color foregroundColor, java.awt.Color backgroundColor)
Sets shading to the specified values on all cells in the table.
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

      • Table

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

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

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

        Parameters:
        doc - The owner document.

        Example:

        Shows how to build a nested table without using DocumentBuilder.
        public void nestedTablesUsingNodeConstructors() throws Exception
        {
            Document doc = new Document();
        
            // Create the outer table with three rows and four columns.
            Table outerTable = createTable(doc, 3, 4, "Outer Table");
            // Add it to the document body.
            doc.getFirstSection().getBody().appendChild(outerTable);
        
            // Create another table with two rows and two columns.
            Table innerTable = createTable(doc, 2, 2, "Inner Table");
            // Add this table to the first cell of the outer table.
            outerTable.getFirstRow().getFirstCell().appendChild(innerTable);
        
            doc.save(getMyDir() + "\\Artifacts\\Table.CreateNestedTable.doc");
        
        }
        
        /**
         * Creates a new table in the document with the given dimensions and text in each cell.
         */
        private Table createTable(Document doc, int rowCount, int cellCount, String cellText)
        {
            Table table = new Table(doc);
        
            // Create the specified number of rows.
            for (int rowId = 1; rowId <= rowCount; rowId++)
            {
                Row row = new Row(doc);
                table.appendChild(row);
        
                // Create the specified number of cells for each row.
                for (int cellId = 1; cellId <= cellCount; cellId++)
                {
                    Cell cell = new Cell(doc);
                    row.appendChild(cell);
                    // Add a blank paragraph to the cell.
                    cell.appendChild(new Paragraph(doc));
        
                    // Add the text.
                    cell.getFirstParagraph().appendChild(new Run(doc, cellText));
                }
            }
        
            return table;
        }
    • Property Getters/Setters Detail

      • getAbsoluteHorizontalDistance

        public double getAbsoluteHorizontalDistance()
        
        Gets absolute horizontal floating table position specified by the table properties, in points. Default value is 0.

        Example:

        Shows how get properties for floating tables
        Document doc = new Document(getMyDir() + "Table.Distance.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        if (table.getTextWrapping() == TextWrapping.AROUND)
        {
            Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.DEFAULT);
            Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT);
            Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.MARGIN);
            Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.PARAGRAPH);
            Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0);
            Assert.assertEquals(table.getAbsoluteVerticalDistance(), 4.8);
            Assert.assertEquals(table.getAllowOverlap(), true);
        }
      • getAbsoluteVerticalDistance

        public double getAbsoluteVerticalDistance()
        
        Gets absolute vertical floating table position specified by the table properties, in points. Default value is 0.

        Example:

        Shows how get properties for floating tables
        Document doc = new Document(getMyDir() + "Table.Distance.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        if (table.getTextWrapping() == TextWrapping.AROUND)
        {
            Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.DEFAULT);
            Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT);
            Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.MARGIN);
            Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.PARAGRAPH);
            Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0);
            Assert.assertEquals(table.getAbsoluteVerticalDistance(), 4.8);
            Assert.assertEquals(table.getAllowOverlap(), true);
        }
      • getAlignment/setAlignment

        public int getAlignment() / public void setAlignment(int value)
        
        Specifies how an inline table is aligned in the document. The value of the property is TableAlignment integer constant.

        The default value is TableAlignment.LEFT.

        Example:

        Shows how to apply a outline border to a table.
        Document doc = new Document(getMyDir() + "Table.EmptyTable.doc");
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        // Align the table to the center of the page.
        table.setAlignment(TableAlignment.CENTER);
        
        // Clear any existing borders from the table.
        table.clearBorders();
        
        // Set a green border around the table but not inside.
        table.setBorder(BorderType.LEFT, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.RIGHT, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.TOP, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.BOTTOM, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        
        // Fill the cells with a light green solid color.
        table.setShading(TextureIndex.TEXTURE_SOLID, Color.GREEN, Color.GREEN);
        
        doc.save(getMyDir() + "\\Artifacts\\Table.SetOutlineBorders.doc");
      • getAllowAutoFit/setAllowAutoFit

        public boolean getAllowAutoFit() / public void setAllowAutoFit(boolean value)
        
        Allows Microsoft Word and Aspose.Words to automatically resize cells in a table to fit their contents.

        The default value is true.

        Example:

        Shows how to set a table to shrink or grow each cell to accommodate its contents.
        table.setAllowAutoFit(true);
        See Also:
        autoFit(int)
      • getAllowCellSpacing/setAllowCellSpacing

        public boolean getAllowCellSpacing() / public void setAllowCellSpacing(boolean value)
        
        Gets or sets the "Allow spacing between cells" option.
      • getAllowOverlap

        public boolean getAllowOverlap()
        
        Gets whether a floating table shall allow other floating objects in the document to overlap its extents when displayed. Default value is true.

        Example:

        Shows how get properties for floating tables
        Document doc = new Document(getMyDir() + "Table.Distance.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        if (table.getTextWrapping() == TextWrapping.AROUND)
        {
            Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.DEFAULT);
            Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT);
            Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.MARGIN);
            Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.PARAGRAPH);
            Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0);
            Assert.assertEquals(table.getAbsoluteVerticalDistance(), 4.8);
            Assert.assertEquals(table.getAllowOverlap(), true);
        }
      • getBidi/setBidi

        public boolean getBidi() / public void setBidi(boolean value)
        
        Gets or sets whether this is a right-to-left table.

        When true, the cells in this row are laid out right to left.

        The default value is false.

      • getBottomPadding/setBottomPadding

        public double getBottomPadding() / public void setBottomPadding(double value)
        
        Gets or sets the amount of space (in points) to add below the contents of cells.

        Example:

        Shows how to create a table that contains a single cell and apply row formatting.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        
        // Set the row formatting
        RowFormat rowFormat = builder.getRowFormat();
        rowFormat.setHeight(100);
        rowFormat.setHeightRule(HeightRule.EXACTLY);
        // These formatting properties are set on the table and are applied to all rows in the table.
        table.setLeftPadding(30);
        table.setRightPadding(30);
        table.setTopPadding(30);
        table.setBottomPadding(30);
        
        builder.writeln("I'm a wonderful formatted row.");
        
        builder.endRow();
        builder.endTable();
      • getCellSpacing/setCellSpacing

        public double getCellSpacing() / public void setCellSpacing(double value)
        
        Gets or sets the amount of space (in points) between the cells.
      • getChildNodes

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

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

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

        Example:

        Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.
        NodeCollection children = paragraph.getChildNodes();
        for (Node child : (Iterable<Node>) children)
        {
            // Paragraph may contain children of various types such as runs, shapes and so on.
            if (child.getNodeType() == NodeType.RUN)
            {
                // Say we found the node that we want, do something useful.
                Run run = (Run) child;
                System.out.println(run.getText());
            }
        }
      • getCount

        public int getCount()
        
        Gets the number of immediate children of this node.
      • getDescription/setDescription

        public java.lang.String getDescription() / public void setDescription(java.lang.String value)
        
        Gets or sets description of this table. It provides an alternative text representation of the information contained in the table.

        The default value is an empty string.

        This property is meaningful for ISO/IEC 29500 compliant DOCX documents (OoxmlCompliance). When saved to pre-ISO/IEC 29500 formats, the property is ignored.

      • getDistanceBottom

        public double getDistanceBottom()
        
        Gets distance between table bottom and the surrounding text, in points.
      • getDistanceLeft

        public double getDistanceLeft()
        
        Gets distance between table left and the surrounding text, in points.
      • getDistanceRight

        public double getDistanceRight()
        
        Gets distance between table right and the surrounding text, in points.
      • getDistanceTop

        public double getDistanceTop()
        
        Gets distance between table top and the surrounding text, in points.
      • getDocument

        public DocumentBase getDocument()
        
        Gets the document to which this node belongs.

        The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.

        Example:

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

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

        Example:

        Shows how to enumerate immediate child nodes of a composite node using NextSibling. In this example we enumerate all paragraphs of a section body.
        // Get the section that we want to work on.
        Section section = doc.getSections().get(0);
        Body body = section.getBody();
        
        // Loop starting from the first child until we reach null.
        for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling())
        {
            // Output the types of the nodes that we come across.
            System.out.println(Node.nodeTypeToString(node.getNodeType()));
        }

        Example:

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

        public Row getFirstRow()
        
        Returns the first Row node in the table.

        Example:

        Demonstrates how to use typed properties to access nodes of the document tree.
        // Quick typed access to the first child Section node of the Document.
        Section section = doc.getFirstSection();
        
        // Quick typed access to the Body child node of the Section.
        Body body = section.getBody();
        
        // Quick typed access to all Table child nodes contained in the Body.
        TableCollection tables = body.getTables();
        
        for (Table table : tables)
        {
            // Quick typed access to the first row of the table.
            if (table.getFirstRow() != null) table.getFirstRow().remove();
        
            // Quick typed access to the last row of the table.
            if (table.getLastRow() != null) table.getLastRow().remove();
        }

        Example:

        Shows how to combine the rows from two tables into one.
        // Load the document.
        Document doc = new Document(getMyDir() + "Table.Document.doc");
        
        // 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(getMyDir() + "\\Artifacts\\Table.CombineTables.doc");
      • hasChildNodes

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

        Example:

        Demonstrates how to use the InsertDocument method to insert a document into a merge field during mail merge.
        public void insertDocumentAtMailMerge() throws Exception
        {
            // Open the main document.
            Document mainDoc = new Document(getMyDir() + "InsertDocument1.doc");
        
            // Add a handler to MergeField event
            mainDoc.getMailMerge().setFieldMergingCallback(new InsertDocumentAtMailMergeHandler());
        
            // The main document has a merge field in it called "Document_1".
            // The corresponding data for this field contains fully qualified path to the document
            // that should be inserted to this field.
            mainDoc.getMailMerge().execute(new String[]{"Document_1"}, new String[]{getMyDir() + "InsertDocument2.doc"});
        
            mainDoc.save(getMyDir() + "\\Artifacts\\InsertDocumentAtMailMerge.doc");
        }
        
        private class InsertDocumentAtMailMergeHandler implements IFieldMergingCallback
        {
            /**
             * This handler makes special processing for the "Document_1" field.
             * The field value contains the path to load the document.
             * We load the document and insert it into the current merge field.
             */
            public void fieldMerging(FieldMergingArgs args) throws Exception
            {
                if ("Document_1".equals(args.getDocumentFieldName()))
                {
                    // Use document builder to navigate to the merge field with the specified name.
                    DocumentBuilder builder = new DocumentBuilder(args.getDocument());
                    builder.moveToMergeField(args.getDocumentFieldName());
        
                    // The name of the document to load and insert is stored in the field value.
                    Document subDoc = new Document((String) args.getFieldValue());
        
                    // Insert the document.
                    insertDocument(builder.getCurrentParagraph(), subDoc);
        
                    // The paragraph that contained the merge field might be empty now and you probably want to delete it.
                    if (!builder.getCurrentParagraph().hasChildNodes()) builder.getCurrentParagraph().remove();
        
                    // Indicate to the mail merge engine that we have inserted what we wanted.
                    args.setText(null);
                }
            }
        
            public void imageFieldMerging(ImageFieldMergingArgs args)
            {
                // Do nothing.
            }
        }
      • getHorizontalAnchor

        public int getHorizontalAnchor()
        
        Gets the base object from which the horizontal positioning of floating table should be calculated. Default value is RelativeHorizontalPosition.COLUMN. The value of the property is RelativeHorizontalPosition integer constant.

        Example:

        Shows how get properties for floating tables
        Document doc = new Document(getMyDir() + "Table.Distance.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        if (table.getTextWrapping() == TextWrapping.AROUND)
        {
            Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.DEFAULT);
            Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT);
            Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.MARGIN);
            Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.PARAGRAPH);
            Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0);
            Assert.assertEquals(table.getAbsoluteVerticalDistance(), 4.8);
            Assert.assertEquals(table.getAllowOverlap(), true);
        }
      • isComposite

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

        Example:

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

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

        Example:

        Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.
        // Document is a CompositeNode and LastChild returns the last child node in the Document node.
        // Since the Document can contain only Section nodes, the last child is the last section.
        Node lastSection = doc.getLastChild();
        
        // Each node knows its next and previous sibling nodes.
        // Previous sibling of a section is a section before the specified section.
        // If the node is the first child, PreviousSibling will return null.
        Node sectionBeforeLast = lastSection.getPreviousSibling();
        
        if (sectionBeforeLast != null) doc.removeChild(sectionBeforeLast);
      • getLastRow

        public Row getLastRow()
        
        Returns the last Row node in the table.

        Example:

        Demonstrates how to use typed properties to access nodes of the document tree.
        // Quick typed access to the first child Section node of the Document.
        Section section = doc.getFirstSection();
        
        // Quick typed access to the Body child node of the Section.
        Body body = section.getBody();
        
        // Quick typed access to all Table child nodes contained in the Body.
        TableCollection tables = body.getTables();
        
        for (Table table : tables)
        {
            // Quick typed access to the first row of the table.
            if (table.getFirstRow() != null) table.getFirstRow().remove();
        
            // Quick typed access to the last row of the table.
            if (table.getLastRow() != null) table.getLastRow().remove();
        }
      • getLeftIndent/setLeftIndent

        public double getLeftIndent() / public void setLeftIndent(double value)
        
        Gets or sets the value that represents the left indent of the table.

        Example:

        Shows how to create a formatted table using DocumentBuilder
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        
        // Make the header row.
        builder.insertCell();
        
        // Set the left indent for the table. Table wide formatting must be applied after
        // at least one row is present in the table.
        table.setLeftIndent(20.0);
        
        // Set height and define the height rule for the header row.
        builder.getRowFormat().setHeight(40.0);
        builder.getRowFormat().setHeightRule(HeightRule.AT_LEAST);
        
        // Some special features for the header row.
        builder.getCellFormat().getShading().setBackgroundPatternColor(new Color(198, 217, 241));
        builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        builder.getFont().setSize(16);
        builder.getFont().setName("Arial");
        builder.getFont().setBold(true);
        
        builder.getCellFormat().setWidth(100.0);
        builder.write("Header Row,\n Cell 1");
        
        // We don't need to specify the width of this cell because it's inherited from the previous cell.
        builder.insertCell();
        builder.write("Header Row,\n Cell 2");
        
        builder.insertCell();
        builder.getCellFormat().setWidth(200.0);
        builder.write("Header Row,\n Cell 3");
        builder.endRow();
        
        // Set features for the other rows and cells.
        builder.getCellFormat().getShading().setBackgroundPatternColor(Color.WHITE);
        builder.getCellFormat().setWidth(100.0);
        builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER);
        
        // Reset height and define a different height rule for table body
        builder.getRowFormat().setHeight(30.0);
        builder.getRowFormat().setHeightRule(HeightRule.AUTO);
        builder.insertCell();
        // Reset font formatting.
        builder.getFont().setSize(12);
        builder.getFont().setBold(false);
        
        // Build the other cells.
        builder.write("Row 1, Cell 1 Content");
        builder.insertCell();
        builder.write("Row 1, Cell 2 Content");
        
        builder.insertCell();
        builder.getCellFormat().setWidth(200.0);
        builder.write("Row 1, Cell 3 Content");
        builder.endRow();
        
        builder.insertCell();
        builder.getCellFormat().setWidth(100.0);
        builder.write("Row 2, Cell 1 Content");
        
        builder.insertCell();
        builder.write("Row 2, Cell 2 Content");
        
        builder.insertCell();
        builder.getCellFormat().setWidth(200.0);
        builder.write("Row 2, Cell 3 Content.");
        builder.endRow();
        builder.endTable();
        
        doc.save(getMyDir() + "\\Artifacts\\DocumentBuilder.CreateFormattedTable.doc");
      • getLeftPadding/setLeftPadding

        public double getLeftPadding() / public void setLeftPadding(double value)
        
        Gets or sets the amount of space (in points) to add to the left of the contents of cells.

        Example:

        Shows how to create a table that contains a single cell and apply row formatting.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        
        // Set the row formatting
        RowFormat rowFormat = builder.getRowFormat();
        rowFormat.setHeight(100);
        rowFormat.setHeightRule(HeightRule.EXACTLY);
        // These formatting properties are set on the table and are applied to all rows in the table.
        table.setLeftPadding(30);
        table.setRightPadding(30);
        table.setTopPadding(30);
        table.setBottomPadding(30);
        
        builder.writeln("I'm a wonderful formatted row.");
        
        builder.endRow();
        builder.endTable();
      • getNextSibling

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

        Example:

        Shows how to enumerate immediate child nodes of a composite node using NextSibling. In this example we enumerate all paragraphs of a section body.
        // Get the section that we want to work on.
        Section section = doc.getSections().get(0);
        Body body = section.getBody();
        
        // Loop starting from the first child until we reach null.
        for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling())
        {
            // Output the types of the nodes that we come across.
            System.out.println(Node.nodeTypeToString(node.getNodeType()));
        }

        Example:

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

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

        Example:

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

        Example:

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

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

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

        Example:

        Shows how to access the parent node.
        // Create a new empty document. It has one section.
        Document doc = new Document();
        
        // The section is the first child node of the document.
        Node section = doc.getFirstChild();
        
        // The section's parent node is the document.
        System.out.println("Section parent is the document: " + (doc == section.getParentNode()));

        Example:

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

        public PreferredWidth getPreferredWidth() / public void setPreferredWidth(PreferredWidth value)
        
        Gets or sets the table preferred width.

        The default value is PreferredWidth.AUTO.

        Example:

        Shows how to set a table to auto fit to 50% of the page width.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a table with a width that takes up half the page width.
        Table table = builder.startTable();
        
        // Insert a few cells
        builder.insertCell();
        table.setPreferredWidth(PreferredWidth.fromPercent(50));
        builder.writeln("Cell #1");
        
        builder.insertCell();
        builder.writeln("Cell #2");
        
        builder.insertCell();
        builder.writeln("Cell #3");
        
        doc.save(getMyDir() + "\\Artifacts\\Table.PreferredWidth.doc");
      • getPreviousSibling

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

        Example:

        Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.
        // Document is a CompositeNode and LastChild returns the last child node in the Document node.
        // Since the Document can contain only Section nodes, the last child is the last section.
        Node lastSection = doc.getLastChild();
        
        // Each node knows its next and previous sibling nodes.
        // Previous sibling of a section is a section before the specified section.
        // If the node is the first child, PreviousSibling will return null.
        Node sectionBeforeLast = lastSection.getPreviousSibling();
        
        if (sectionBeforeLast != null) doc.removeChild(sectionBeforeLast);
      • getRange

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

        Example:

        Shows how to delete all characters of a range.
        // Open Word document.
        Document doc = new Document(getMyDir() + "Range.DeleteSection.doc");
        
        // The document contains two sections. Each section has a paragraph of text.
        System.out.println(doc.getText());
        
        // Delete the first section from the document.
        doc.getSections().get(0).getRange().delete();
        
        // Check the first section was deleted by looking at the text of the whole document again.
        System.out.println(doc.getText());
      • getRelativeHorizontalAlignment

        public int getRelativeHorizontalAlignment()
        
        Gets floating table relative horizontal alignment. The value of the property is HorizontalAlignment integer constant.

        Example:

        Shows how get properties for floating tables
        Document doc = new Document(getMyDir() + "Table.Distance.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        if (table.getTextWrapping() == TextWrapping.AROUND)
        {
            Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.DEFAULT);
            Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT);
            Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.MARGIN);
            Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.PARAGRAPH);
            Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0);
            Assert.assertEquals(table.getAbsoluteVerticalDistance(), 4.8);
            Assert.assertEquals(table.getAllowOverlap(), true);
        }
      • getRelativeVerticalAlignment

        public int getRelativeVerticalAlignment()
        
        Gets floating table relative vertical alignment. The value of the property is VerticalAlignment integer constant.

        Example:

        Shows how get properties for floating tables
        Document doc = new Document(getMyDir() + "Table.Distance.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        if (table.getTextWrapping() == TextWrapping.AROUND)
        {
            Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.DEFAULT);
            Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT);
            Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.MARGIN);
            Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.PARAGRAPH);
            Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0);
            Assert.assertEquals(table.getAbsoluteVerticalDistance(), 4.8);
            Assert.assertEquals(table.getAllowOverlap(), true);
        }
      • getRightPadding/setRightPadding

        public double getRightPadding() / public void setRightPadding(double value)
        
        Gets or sets the amount of space (in points) to add to the right of the contents of cells.

        Example:

        Shows how to create a table that contains a single cell and apply row formatting.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        
        // Set the row formatting
        RowFormat rowFormat = builder.getRowFormat();
        rowFormat.setHeight(100);
        rowFormat.setHeightRule(HeightRule.EXACTLY);
        // These formatting properties are set on the table and are applied to all rows in the table.
        table.setLeftPadding(30);
        table.setRightPadding(30);
        table.setTopPadding(30);
        table.setBottomPadding(30);
        
        builder.writeln("I'm a wonderful formatted row.");
        
        builder.endRow();
        builder.endTable();
      • getRows

        public RowCollection getRows()
        
        Provides typed access to the rows of the table.

        Example:

        Shows how to combine the rows from two tables into one.
        // Load the document.
        Document doc = new Document(getMyDir() + "Table.Document.doc");
        
        // 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(getMyDir() + "\\Artifacts\\Table.CombineTables.doc");

        Example:

        Shows how to iterate through all tables in the document and display the content from each cell.
        Document doc = new Document(getMyDir() + "Table.Document.doc");
        
        // Here we get all tables from the Document node. You can do this for any other composite node
        // which can contain block level nodes. For example you can retrieve tables from header or from a cell
        // containing another table (nested tables).
        NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
        
        // Iterate through all tables in the document
        for (Table table : (Iterable<Table>) tables)
        {
            // Get the index of the table node as contained in the parent node of the table
            int tableIndex = table.getParentNode().getChildNodes().indexOf(table);
            System.out.println(MessageFormat.format("Start of Table {0}", tableIndex));
        
            // Iterate through all rows in the table
            for (Row row : table.getRows())
            {
                int rowIndex = table.getRows().indexOf(row);
                System.out.println(MessageFormat.format("\tStart of Row {0}", rowIndex));
        
                // Iterate through all cells in the row
                for (Cell cell : row.getCells())
                {
                    int cellIndex = row.getCells().indexOf(cell);
                    // Get the plain text content of this cell.
                    String cellText = cell.toString(SaveFormat.TEXT).trim();
                    // Print the content of the cell.
                    System.out.println(MessageFormat.format("\t\tContents of Cell:{0} = \"{1}\"", cellIndex, cellText));
                }
                //Console.WriteLine();
                System.out.println(MessageFormat.format("\tEnd of Row {0}", rowIndex));
            }
            System.out.println(MessageFormat.format("End of Table {0}", tableIndex));
            System.out.println();
        }
      • getStyle/setStyle

        public Style getStyle() / public void setStyle(Style value)
        
        Gets or sets the table style applied to this table.
      • getStyleIdentifier/setStyleIdentifier

        public int getStyleIdentifier() / public void setStyleIdentifier(int value)
        
        Gets or sets the locale independent style identifier of the table style applied to this table. The value of the property is StyleIdentifier integer constant.

        Example:

        Shows how to build a new table with a table style applied.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        // We must insert at least one row first before setting any table formatting.
        builder.insertCell();
        // Set the table style used based of the unique style identifier.
        // Note that not all table styles are available when saving as .doc format.
        table.setStyleIdentifier(StyleIdentifier.MEDIUM_SHADING_1_ACCENT_1);
        // Apply which features should be formatted by the style.
        table.setStyleOptions(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW);
        table.autoFit(AutoFitBehavior.AUTO_FIT_TO_CONTENTS);
        
        // Continue with building the table as normal.
        builder.writeln("Item");
        builder.getCellFormat().setRightPadding(40);
        builder.insertCell();
        builder.writeln("Quantity (kg)");
        builder.endRow();
        
        builder.insertCell();
        builder.writeln("Apples");
        builder.insertCell();
        builder.writeln("20");
        builder.endRow();
        
        builder.insertCell();
        builder.writeln("Bananas");
        builder.insertCell();
        builder.writeln("40");
        builder.endRow();
        
        builder.insertCell();
        builder.writeln("Carrots");
        builder.insertCell();
        builder.writeln("50");
        builder.endRow();
        
        doc.save(getMyDir() + "\\Artifacts\\DocumentBuilder.SetTableStyle.docx");
      • getStyleName/setStyleName

        public java.lang.String getStyleName() / public void setStyleName(java.lang.String value)
        
        Gets or sets the name of the table style applied to this table.
      • getStyleOptions/setStyleOptions

        public int getStyleOptions() / public void setStyleOptions(int value)
        
        Gets or sets bit flags that specify how a table style is applied to this table. The value of the property is TableStyleOptions integer constant.

        Example:

        Shows how to build a new table with a table style applied.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        // We must insert at least one row first before setting any table formatting.
        builder.insertCell();
        // Set the table style used based of the unique style identifier.
        // Note that not all table styles are available when saving as .doc format.
        table.setStyleIdentifier(StyleIdentifier.MEDIUM_SHADING_1_ACCENT_1);
        // Apply which features should be formatted by the style.
        table.setStyleOptions(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW);
        table.autoFit(AutoFitBehavior.AUTO_FIT_TO_CONTENTS);
        
        // Continue with building the table as normal.
        builder.writeln("Item");
        builder.getCellFormat().setRightPadding(40);
        builder.insertCell();
        builder.writeln("Quantity (kg)");
        builder.endRow();
        
        builder.insertCell();
        builder.writeln("Apples");
        builder.insertCell();
        builder.writeln("20");
        builder.endRow();
        
        builder.insertCell();
        builder.writeln("Bananas");
        builder.insertCell();
        builder.writeln("40");
        builder.endRow();
        
        builder.insertCell();
        builder.writeln("Carrots");
        builder.insertCell();
        builder.writeln("50");
        builder.endRow();
        
        doc.save(getMyDir() + "\\Artifacts\\DocumentBuilder.SetTableStyle.docx");
      • getTextWrapping/setTextWrapping

        public int getTextWrapping() / public void setTextWrapping(int value)
        
        Gets or sets TextWrapping for table. The value of the property is TextWrapping integer constant.
      • getTitle/setTitle

        public java.lang.String getTitle() / public void setTitle(java.lang.String value)
        
        Gets or sets title of this table. It provides an alternative text representation of the information contained in the table.

        The default value is an empty string.

        This property is meaningful for ISO/IEC 29500 compliant DOCX documents (OoxmlCompliance). When saved to pre-ISO/IEC 29500 formats, the property is ignored.

      • getTopPadding/setTopPadding

        public double getTopPadding() / public void setTopPadding(double value)
        
        Gets or sets the amount of space (in points) to add above the contents of cells.

        Example:

        Shows how to create a table that contains a single cell and apply row formatting.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        
        // Set the row formatting
        RowFormat rowFormat = builder.getRowFormat();
        rowFormat.setHeight(100);
        rowFormat.setHeightRule(HeightRule.EXACTLY);
        // These formatting properties are set on the table and are applied to all rows in the table.
        table.setLeftPadding(30);
        table.setRightPadding(30);
        table.setTopPadding(30);
        table.setBottomPadding(30);
        
        builder.writeln("I'm a wonderful formatted row.");
        
        builder.endRow();
        builder.endTable();
      • getVerticalAnchor

        public int getVerticalAnchor()
        
        Gets the base object from which the vertical positioning of floating table should be calculated. Default value is RelativeVerticalPosition.MARGIN. The value of the property is RelativeVerticalPosition integer constant.

        Example:

        Shows how get properties for floating tables
        Document doc = new Document(getMyDir() + "Table.Distance.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        if (table.getTextWrapping() == TextWrapping.AROUND)
        {
            Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.DEFAULT);
            Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT);
            Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.MARGIN);
            Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.PARAGRAPH);
            Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0);
            Assert.assertEquals(table.getAbsoluteVerticalDistance(), 4.8);
            Assert.assertEquals(table.getAllowOverlap(), true);
        }
    • 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.VisitTableStart, then calls Accept for all child nodes of the section and calls DocumentVisitor.VisitTableEnd at the end.
        Parameters:
        visitor - The visitor that will visit the nodes.
        Returns:
        True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

        Example:

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

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

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

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

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

        Example:

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

        public void autoFit(int behavior)
                    throws java.lang.Exception
        Resizes the table and cells according to the specified auto fit behavior.

        This method mimics the commands available in the Auto Fit menu for a table in Microsoft Word. The commands available are "Auto Fit to Contents", "Auto Fit to Window" and "Fixed Column Width". In Microsoft Word these commands set relevant table properties and then update the table layout and Aspose.Words does the same for you.

        Parameters:
        behavior - A AutoFitBehavior value. Specifies how to auto fit the table.

        Example:

        Shows how to build a new table with a table style applied.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        // We must insert at least one row first before setting any table formatting.
        builder.insertCell();
        // Set the table style used based of the unique style identifier.
        // Note that not all table styles are available when saving as .doc format.
        table.setStyleIdentifier(StyleIdentifier.MEDIUM_SHADING_1_ACCENT_1);
        // Apply which features should be formatted by the style.
        table.setStyleOptions(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW);
        table.autoFit(AutoFitBehavior.AUTO_FIT_TO_CONTENTS);
        
        // Continue with building the table as normal.
        builder.writeln("Item");
        builder.getCellFormat().setRightPadding(40);
        builder.insertCell();
        builder.writeln("Quantity (kg)");
        builder.endRow();
        
        builder.insertCell();
        builder.writeln("Apples");
        builder.insertCell();
        builder.writeln("20");
        builder.endRow();
        
        builder.insertCell();
        builder.writeln("Bananas");
        builder.insertCell();
        builder.writeln("40");
        builder.endRow();
        
        builder.insertCell();
        builder.writeln("Carrots");
        builder.insertCell();
        builder.writeln("50");
        builder.endRow();
        
        doc.save(getMyDir() + "\\Artifacts\\DocumentBuilder.SetTableStyle.docx");

        Example:

        Shows how to build a formatted table that contains 2 rows and 2 columns.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        
        // Insert a cell
        builder.insertCell();
        // Use fixed column widths.
        table.autoFit(AutoFitBehavior.FIXED_COLUMN_WIDTHS);
        
        builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER);
        builder.write("This is row 1 cell 1");
        
        // Insert a cell
        builder.insertCell();
        builder.write("This is row 1 cell 2");
        
        builder.endRow();
        
        // Insert a cell
        builder.insertCell();
        
        // Apply new row formatting
        builder.getRowFormat().setHeight(100);
        builder.getRowFormat().setHeightRule(HeightRule.EXACTLY);
        
        builder.getCellFormat().setOrientation(TextOrientation.UPWARD);
        builder.writeln("This is row 2 cell 1");
        
        // Insert a cell
        builder.insertCell();
        builder.getCellFormat().setOrientation(TextOrientation.DOWNWARD);
        builder.writeln("This is row 2 cell 2");
        
        builder.endRow();
        
        builder.endTable();
      • clearBorders

        public void clearBorders()
        Removes all table and cell borders on this table.

        Example:

        Shows how to apply a outline border to a table.
        Document doc = new Document(getMyDir() + "Table.EmptyTable.doc");
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        // Align the table to the center of the page.
        table.setAlignment(TableAlignment.CENTER);
        
        // Clear any existing borders from the table.
        table.clearBorders();
        
        // Set a green border around the table but not inside.
        table.setBorder(BorderType.LEFT, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.RIGHT, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.TOP, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.BOTTOM, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        
        // Fill the cells with a light green solid color.
        table.setShading(TextureIndex.TEXTURE_SOLID, Color.GREEN, Color.GREEN);
        
        doc.save(getMyDir() + "\\Artifacts\\Table.SetOutlineBorders.doc");

        Example:

        Shows how to remove all borders from a table.
        Document doc = new Document(getMyDir() + "Table.Document.doc");
        
        // Remove all borders from the first table in the document.
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        // Clear the borders all cells in the table.
        table.clearBorders();
        
        doc.save(getMyDir() + "\\Artifacts\\Table.ClearBorders.doc");
      • clearShading

        public void clearShading()
        Removes all shading on the table.
      • deepClone

        public Node deepClone(boolean isCloneChildren)

        Example:

        Shows how to clone composite nodes with and without their child nodes.
        // Create a new empty document.
        Document doc = new Document();
        
        // Add some text to the first paragraph
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        para.appendChild(new Run(doc, "Some text"));
        
        // Clone the paragraph and the child nodes.
        Node cloneWithChildren = para.deepClone(true);
        // Only clone the paragraph and no child nodes.
        Node cloneWithoutChildren = para.deepClone(false);
      • ensureMinimum

        public void ensureMinimum()
        If the table has no rows, creates and appends one Row.

        Example:

        Shows how to ensure a table node is valid.
        Document doc = new Document();
        
        // Create a new table and add it to the document.
        Table table = new Table(doc);
        doc.getFirstSection().getBody().appendChild(table);
        
        // Ensure the table is valid (has at least one row with one cell).
        table.ensureMinimum();
      • getAncestor

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

        Example:

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

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

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

        Parameters:
        ancestorType - The object type of the ancestor to retrieve.
        Returns:
        The ancestor of the specified type or null if no ancestor of this type was found.
      • 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 test if a node is inside a field by using an XPath expression.
        // Let's pick a document we know has some fields in.
        Document doc = new Document(getMyDir() + "MailMerge.MergeImage.doc");
        
        // Let's say we want to check if the Run below is inside a field.
        Run run = (Run) doc.getChild(NodeType.RUN, 5, true);
        
        // Evaluate the XPath expression. The resulting NodeList will contain all nodes found inside a field a field (between FieldStart
        // and FieldEnd exclusive). There can however be FieldStart and FieldEnd nodes in the list if there are nested fields
        // in the path. Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs.
        NodeList resultList = doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]");
        
        // Check if the specified run is one of the nodes that are inside the field.
        for (Node node : (Iterable<Node>) resultList)
        {
            if (node == run)
            {
                System.out.println("The node is found inside a field");
                break;
            }
        }

        Example:

        Shows how to extract a specific child node from a CompositeNode by using the GetChild method and passing the NodeType and index.
        Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
      • 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 as files.
        public void extractImagesToFiles() throws Exception
        {
            Document doc = new Document(getMyDir() + "Image.SampleImages.doc");
        
            NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
            int imageIndex = 0;
            for (Shape shape : (Iterable<Shape>) shapes)
            {
                if (shape.hasImage())
                {
                    String imageFileName = java.text.MessageFormat.format("\\Artifacts\\Image.ExportImages.{0} Out{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
                    shape.getImageData().save(getMyDir() + imageFileName);
                    imageIndex++;
                }
            }
        }

        Example:

        Demonstrates how to remove a specified TOC from a document.
        public void removeTOCFromDocument() throws Exception
        {
            // Open a document which contains a TOC.
            Document doc = new Document(getMyDir() + "Document.TableOfContents.doc");
        
            // Remove the first TOC from the document.
            Field tocField = doc.getRange().getFields().get(0);
            tocField.remove();
        
            // Save the output.
            doc.save(getMyDir() + "\\Artifacts\\Document.TableOfContentsRemoveTOC.doc");
        }
      • 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 the difference between calling the GetText and ToString methods on a node.
        Document doc = new Document();
        
        // Enter a dummy field into the document.
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertField("MERGEFIELD Field");
        
        // GetText will retrieve all field codes and special characters
        System.out.println("GetText() Result: " + doc.getText());
        
        // ToString will export the node to the specified format. When converted to text it will not retrieve fields code
        // or special characters, but will still contain some natural formatting characters such as paragraph markers etc.
        // This is the same as "viewing" the document as if it was opened in a text editor.
        System.out.println("ToString() Result: " + doc.toString(SaveFormat.TEXT));

        Example:

        Finds and outputs all paragraphs in a document that are bulleted or numbered.
        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());
            }
        }
      • 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.doc");
        
        // Get the body of the first section in the document.
        Body body = doc.getFirstSection().getBody();
        // Retrieve the index of the last paragraph in the body.
        int index = body.getChildNodes().indexOf(body.getLastParagraph());

        Example:

        Retrieves the index of a row in a table.
        int rowIndex = table.indexOf(row);

        Example:

        Retrieves the index of a cell in a row.
        int cellIndex = row.indexOf(cell);
      • insertAfter

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

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

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

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

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

        Example:

        Shows how to replace all textboxes with images.
        Document doc = new Document(getMyDir() + "Shape.ReplaceTextboxesWithImages.doc");
        
        // 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() + "Hammer.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(getMyDir() + "\\Artifacts\\Shape.ReplaceTextboxesWithImages.doc");
      • insertBefore

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

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

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

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

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

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

        Example:

        Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.
        NodeCollection children = paragraph.getChildNodes();
        for (Node child : (Iterable<Node>) children)
        {
            // Paragraph may contain children of various types such as runs, shapes and so on.
            if (child.getNodeType() == NodeType.RUN)
            {
                // Say we found the node that we want, do something useful.
                Run run = (Run) child;
                System.out.println(run.getText());
            }
        }
      • nextPreOrder

        public Node nextPreOrder(Node rootNode)
        Gets next node according to the pre-order tree traversal algorithm.
        Parameters:
        rootNode - The top node (limit) of traversal.
        Returns:
        Next node in pre-order order. Null if reached the rootNode.

        Example:

        Shows how to delete all images from a document using pre-order tree traversal.
        Node curNode = doc;
        while (curNode != null)
        {
            Node nextNode = curNode.nextPreOrder(doc);
        
            if (curNode.getNodeType() == NodeType.SHAPE)
            {
                Shape shape = (Shape) curNode;
        
                // Several shape types can have an image including image shapes and OLE objects.
                if (shape.hasImage()) shape.remove();
            }
        
            curNode = nextNode;
        }
      • prependChild

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

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

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

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

        public Node previousPreOrder(Node rootNode)
        Gets the previous node according to the pre-order tree traversal algorithm.
        Parameters:
        rootNode - The top node (limit) of traversal.
        Returns:
        Previous node in pre-order order. Null if reached the rootNode.
      • remove

        public void remove()
        Removes itself from the parent.

        Example:

        Shows how to remove all nodes of a specific type from a composite node. In this example we remove tables from a section body.
        // Get the section that we want to work on.
        Section section = doc.getSections().get(0);
        Body body = section.getBody();
        
        // Select the first child node in the body.
        Node curNode = body.getFirstChild();
        
        while (curNode != null)
        {
            // Save the pointer to the next sibling node because if the current
            // node is removed from the parent in the next step, we will have
            // no way of finding the next node to continue the loop.
            Node nextNode = curNode.getNextSibling();
        
            // A section body can contain Paragraph and Table nodes.
            // If the node is a Table, remove it from the parent.
            if (curNode.getNodeType() == NodeType.TABLE) curNode.remove();
        
            // Continue going through child nodes until null (no more siblings) is reached.
            curNode = nextNode;
        }

        Example:

        Shows how to delete all images from a document.
        // Here we get all shapes from the document node, but you can do this for any smaller
        // node too, for example delete shapes from a single section or a paragraph.
        NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
        
        // We cannot delete shape nodes while we enumerate through the collection.
        // One solution is to add nodes that we want to delete to a temporary array and delete afterwards.
        ArrayList shapesToDelete = new ArrayList();
        for (Shape shape : (Iterable<Shape>) shapes)
        {
            // Several shape types can have an image including image shapes and OLE objects.
            if (shape.hasImage()) shapesToDelete.add(shape);
        }
        
        // Now we can delete shapes.
        for (Shape shape : (Iterable<Shape>) shapesToDelete)
            shape.remove();
      • removeAllChildren

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

        Example:

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

        Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.
        // Document is a CompositeNode and LastChild returns the last child node in the Document node.
        // Since the Document can contain only Section nodes, the last child is the last section.
        Node lastSection = doc.getLastChild();
        
        // Each node knows its next and previous sibling nodes.
        // Previous sibling of a section is a section before the specified section.
        // If the node is the first child, PreviousSibling will return null.
        Node sectionBeforeLast = lastSection.getPreviousSibling();
        
        if (sectionBeforeLast != null) doc.removeChild(sectionBeforeLast);
      • removeSmartTags

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

        Example:

        Removes all smart tags from descendant nodes of the composite node.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // Remove smart tags from the first paragraph in the document.
        doc.getFirstSection().getBody().getFirstParagraph().removeSmartTags();

        Example:

        Shows how to remove all smart tags from a document.
        Document doc = new Document(getMyDir() + "Document.doc");
        doc.removeSmartTags();
      • 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 test if a node is inside a field by using an XPath expression.
        // Let's pick a document we know has some fields in.
        Document doc = new Document(getMyDir() + "MailMerge.MergeImage.doc");
        
        // Let's say we want to check if the Run below is inside a field.
        Run run = (Run) doc.getChild(NodeType.RUN, 5, true);
        
        // Evaluate the XPath expression. The resulting NodeList will contain all nodes found inside a field a field (between FieldStart
        // and FieldEnd exclusive). There can however be FieldStart and FieldEnd nodes in the list if there are nested fields
        // in the path. Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs.
        NodeList resultList = doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]");
        
        // Check if the specified run is one of the nodes that are inside the field.
        for (Node node : (Iterable<Node>) resultList)
        {
            if (node == run)
            {
                System.out.println("The node is found inside a field");
                break;
            }
        }

        Example:

        Shows how to select certain nodes by using an XPath expression.
        Document doc = new Document(getMyDir() + "Table.Document.doc");
        
        // This expression will extract all paragraph nodes which are descendants of any table node in the document.
        // This will return any paragraphs which are in a table.
        NodeList nodeList = doc.selectNodes("//Table//Paragraph");
        
        // This expression will select any paragraphs that are direct children of any body node in the document.
        nodeList = doc.selectNodes("//Body/Paragraph");
        
        // Use SelectSingleNode to select the first result of the same expression as above.
        Node node = doc.selectSingleNode("//Body/Paragraph");
      • 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() + "Table.Document.doc");
        
        // This expression will extract all paragraph nodes which are descendants of any table node in the document.
        // This will return any paragraphs which are in a table.
        NodeList nodeList = doc.selectNodes("//Table//Paragraph");
        
        // This expression will select any paragraphs that are direct children of any body node in the document.
        nodeList = doc.selectNodes("//Body/Paragraph");
        
        // Use SelectSingleNode to select the first result of the same expression as above.
        Node node = doc.selectSingleNode("//Body/Paragraph");
      • setBorder

        public void setBorder(int borderType, int lineStyle, double lineWidth, java.awt.Color color, boolean isOverrideCellBorders)
                      throws java.lang.Exception
        Sets the specified table border to the specified line style, width and color.
        Parameters:
        borderType - A BorderType value. The table border to change.
        lineStyle - A LineStyle value. The line style to apply.
        lineWidth - The line width to set (in points).
        color - The color to use for the border.
        isOverrideCellBorders - When true, causes all existing explicit cell borders to be removed.

        Example:

        Shows how to apply a outline border to a table.
        Document doc = new Document(getMyDir() + "Table.EmptyTable.doc");
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        // Align the table to the center of the page.
        table.setAlignment(TableAlignment.CENTER);
        
        // Clear any existing borders from the table.
        table.clearBorders();
        
        // Set a green border around the table but not inside.
        table.setBorder(BorderType.LEFT, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.RIGHT, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.TOP, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.BOTTOM, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        
        // Fill the cells with a light green solid color.
        table.setShading(TextureIndex.TEXTURE_SOLID, Color.GREEN, Color.GREEN);
        
        doc.save(getMyDir() + "\\Artifacts\\Table.SetOutlineBorders.doc");
      • setBorders

        public void setBorders(int lineStyle, double lineWidth, java.awt.Color color)
                       throws java.lang.Exception
        Sets all table borders to the specified line style, width and color.
        Parameters:
        lineStyle - A LineStyle value. The line style to apply.
        lineWidth - The line width to set (in points).
        color - The color to use for the border.

        Example:

        Shows how to format table and cell with different borders and shadings
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        
        // Set the borders for the entire table.
        table.setBorders(LineStyle.SINGLE, 2.0, Color.BLACK);
        // Set the cell shading for this cell.
        builder.getCellFormat().getShading().setBackgroundPatternColor(Color.RED);
        builder.writeln("Cell #1");
        
        builder.insertCell();
        // Specify a different cell shading for the second cell.
        builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN);
        builder.writeln("Cell #2");
        
        // End this row.
        builder.endRow();
        
        // Clear the cell formatting from previous operations.
        builder.getCellFormat().clearFormatting();
        
        // Create the second row.
        builder.insertCell();
        
        // Create larger borders for the first cell of this row. This will be different
        // compared to the borders set for the table.
        builder.getCellFormat().getBorders().getLeft().setLineWidth(4.0);
        builder.getCellFormat().getBorders().getRight().setLineWidth(4.0);
        builder.getCellFormat().getBorders().getTop().setLineWidth(4.0);
        builder.getCellFormat().getBorders().getBottom().setLineWidth(4.0);
        builder.writeln("Cell #3");
        
        builder.insertCell();
        // Clear the cell formatting from the previous cell.
        builder.getCellFormat().clearFormatting();
        builder.writeln("Cell #4");
        
        doc.save(getMyDir() + "\\Artifacts\\Table.SetBordersAndShading.doc");

        Example:

        Shows how to build a table with all borders enabled (grid).
        Document doc = new Document(getMyDir() + "Table.EmptyTable.doc");
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        // Clear any existing borders from the table.
        table.clearBorders();
        
        // Set a green border around and inside the table.
        table.setBorders(LineStyle.SINGLE, 1.5, Color.GREEN);
        
        doc.save(getMyDir() + "\\Artifacts\\Table.SetAllBorders.doc");
      • setShading

        public void setShading(int texture, java.awt.Color foregroundColor, java.awt.Color backgroundColor)
        Sets shading to the specified values on all cells in the table.
        Parameters:
        texture - A TextureIndex value. The texture to apply.
        foregroundColor - The color of the texture.
        backgroundColor - The color of the background fill.

        Example:

        Shows how to apply a outline border to a table.
        Document doc = new Document(getMyDir() + "Table.EmptyTable.doc");
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        // Align the table to the center of the page.
        table.setAlignment(TableAlignment.CENTER);
        
        // Clear any existing borders from the table.
        table.clearBorders();
        
        // Set a green border around the table but not inside.
        table.setBorder(BorderType.LEFT, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.RIGHT, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.TOP, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        table.setBorder(BorderType.BOTTOM, LineStyle.SINGLE, 1.5, Color.GREEN, true);
        
        // Fill the cells with a light green solid color.
        table.setShading(TextureIndex.TEXTURE_SOLID, Color.GREEN, Color.GREEN);
        
        doc.save(getMyDir() + "\\Artifacts\\Table.SetOutlineBorders.doc");
      • toString

        public java.lang.String toString(SaveOptions saveOptions)
                       throws java.lang.Exception
        Exports the content of the node into a string using the specified save options.
        Parameters:
        saveOptions - Specifies the options that control how the node is saved.
        Returns:
        The content of the node in the specified format.

        Example:

        Exports the content of a node to string in HTML format using custom specified options.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // Extract the last paragraph in the document to convert to HTML.
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // Create an instance of HtmlSaveOptions and set a few options.
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setExportHeadersFootersMode(ExportHeadersFootersMode.PER_SECTION);
        saveOptions.setExportRelativeFontSize(true);
        
        // Convert the document to HTML and return as a string. Pass the instance of HtmlSaveOptions to
        // to use the specified options during the conversion.
        String nodeAsHtml = node.toString(saveOptions);
      • toString

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

        Example:

        Shows how to extract the label of each paragraph in a list as a value or a String.
        Document doc = new Document(getMyDir() + "Lists.PrintOutAllLists.doc");
        doc.updateListLabels();
        int listParaCount = 1;
        
        for (Paragraph paragraph : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true))
        {
            // Find if we have the paragraph list. In our document our list uses plain arabic numbers,
            // which start at three and ends at six.
            if (paragraph.getListFormat().isListItem())
            {
                System.out.println(MessageFormat.format("Paragraph #{0}", listParaCount));
        
                // This is the text we get when actually getting when we output this node to text format.
                // The list labels are not included in this text output. Trim any paragraph formatting characters.
                String paragraphText = paragraph.toString(SaveFormat.TEXT).trim();
                System.out.println("Exported Text: " + paragraphText);
        
                ListLabel label = paragraph.getListLabel();
                // This gets the position of the paragraph in current level of the list. If we have a list with multiple level then this
                // will tell us what position it is on that particular level.
                System.out.println("Numerical Id: " + label.getLabelValue());
        
                // Combine them together to include the list label with the text in the output.
                System.out.println("List label combined with text: " + label.getLabelString() + " " + paragraphText);
        
                listParaCount++;
            }
        }

        Example:

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

        Example:

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