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 create a simple table.
Document doc = new Document();

// Tables are placed in the body of a document
Table table = new Table(doc);
doc.getFirstSection().getBody().appendChild(table);

// Tables contain rows, which contain cells,
// which contain contents such as paragraphs, runs and even other tables
// Calling table.EnsureMinimum will also make sure that a table has at least one row, cell and paragraph
Row firstRow = new Row(doc);
table.appendChild(firstRow);

Cell firstCell = new Cell(doc);
firstRow.appendChild(firstCell);

Paragraph paragraph = new Paragraph(doc);
firstCell.appendChild(paragraph);

Run run = new Run(doc, "Hello world!");
paragraph.appendChild(run);

doc.save(getArtifactsDir() + "Table.CreateTable.docx");

Example:

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

// 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)
TableCollection tables = doc.getFirstSection().getBody().getTables();

// We can make a new array to clone all of the tables in the collection
Assert.assertEquals(tables.toArray().length, 2);

// Iterate through all tables in the document
for (int i = 0; i < tables.getCount(); i++) {
    // Get the index of the table node as contained in the parent node of the table
    System.out.println(MessageFormat.format("Start of Table {0}", i));

    RowCollection rows = tables.get(i).getRows();

    // Iterate through all rows in the table
    for (int j = 0; j < rows.getCount(); j++) {
        System.out.println(MessageFormat.format("\tStart of Row {0}", j));

        CellCollection cells = rows.get(j).getCells();

        // Iterate through all cells in the row
        for (int k = 0; k < cells.getCount(); k++) {
            // Get the plain text content of this cell.
            String cellText = cells.get(k).toString(SaveFormat.TEXT).trim();
            // Print the content of the cell.
            System.out.println(MessageFormat.format("\t\tContents of Cell:{0} = \"{1}\"", k, cellText));
        }

        System.out.println(MessageFormat.format("\tEnd of Row {0}", j));
    }

    System.out.println(MessageFormat.format("End of Table {0}\n", i));
}

Example:

Shows how to build a nested table without using DocumentBuilder.
public void createNestedTable() 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(getArtifactsDir() + "Table.CreateNestedTable.docx");
}

/**
 * Creates a new table in the document with the given dimensions and text in each cell.
 */
private Table createTable(final Document doc, final int rowCount, final int cellCount, final String cellText) throws Exception {
    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));
        }
    }

    // You can add title and description to your table only when added at least one row to the table first
    // This properties are meaningful for ISO / IEC 29500 compliant DOCX documents(see the OoxmlCompliance class)
    // When saved to pre-ISO/IEC 29500 formats, the properties are ignored
    table.setTitle("Aspose table title");
    table.setDescription("Aspose table description");

    return table;
}

Example:

Shows how to build a formatted 2x2 table.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Table table = builder.startTable();
builder.insertCell();
builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER);
builder.write("Row 1, cell 1.");
builder.insertCell();
builder.write("Row 1, cell 2.");
builder.endRow();

// While building the table, the document builder will apply its current RowFormat/CellFormat attribute values
// to the current row/cell that its cursor is in and any new rows/cells as it creates them.
Assert.assertEquals(CellVerticalAlignment.CENTER, table.getRows().get(0).getCells().get(0).getCellFormat().getVerticalAlignment());
Assert.assertEquals(CellVerticalAlignment.CENTER, table.getRows().get(0).getCells().get(1).getCellFormat().getVerticalAlignment());

builder.insertCell();
builder.getRowFormat().setHeight(100.0);
builder.getRowFormat().setHeightRule(HeightRule.EXACTLY);
builder.getCellFormat().setOrientation(TextOrientation.UPWARD);
builder.write("Row 2, cell 1.");
builder.insertCell();
builder.getCellFormat().setOrientation(TextOrientation.DOWNWARD);
builder.write("Row 2, cell 2.");
builder.endRow();
builder.endTable();

// Previously added rows and cells are not retroactively affected by changes to the builder's formatting.
Assert.assertEquals(0.0, table.getRows().get(0).getRowFormat().getHeight());
Assert.assertEquals(HeightRule.AUTO, table.getRows().get(0).getRowFormat().getHeightRule());
Assert.assertEquals(100.0, table.getRows().get(1).getRowFormat().getHeight());
Assert.assertEquals(HeightRule.EXACTLY, table.getRows().get(1).getRowFormat().getHeightRule());
Assert.assertEquals(TextOrientation.UPWARD, table.getRows().get(1).getCells().get(0).getCellFormat().getOrientation());
Assert.assertEquals(TextOrientation.DOWNWARD, table.getRows().get(1).getCells().get(1).getCellFormat().getOrientation());

doc.save(getArtifactsDir() + "DocumentBuilder.BuildTable.docx");

Constructor Summary
Table(DocumentBase doc)
Initializes a new instance of the Table class.
 
Property Getters/Setters Summary
doublegetAbsoluteHorizontalDistance()
void
           Gets or sets absolute horizontal floating table position specified by the table properties, in points. Default value is 0.
doublegetAbsoluteVerticalDistance()
void
           Gets or sets 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()
void
           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()
void
           Gets or sets floating table relative horizontal alignment. The value of the property is HorizontalAlignment integer constant.
intgetRelativeVerticalAlignment()
void
           Gets or sets 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()
void
           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.
voidconvertToHorizontallyMergedCells()
Converts cells horizontally merged by width to cells merged by CellFormat.HorizontalMerge.
NodedeepClone(boolean isCloneChildren)
Creates a duplicate of the node.
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 createNestedTable() 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(getArtifactsDir() + "Table.CreateNestedTable.docx");
        }
        
        /**
         * Creates a new table in the document with the given dimensions and text in each cell.
         */
        private Table createTable(final Document doc, final int rowCount, final int cellCount, final String cellText) throws Exception {
            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));
                }
            }
        
            // You can add title and description to your table only when added at least one row to the table first
            // This properties are meaningful for ISO / IEC 29500 compliant DOCX documents(see the OoxmlCompliance class)
            // When saved to pre-ISO/IEC 29500 formats, the properties are ignored
            table.setTitle("Aspose table title");
            table.setDescription("Aspose table description");
        
            return table;
        }

        Example:

        Shows how to create a simple table.
        Document doc = new Document();
        
        // Tables are placed in the body of a document
        Table table = new Table(doc);
        doc.getFirstSection().getBody().appendChild(table);
        
        // Tables contain rows, which contain cells,
        // which contain contents such as paragraphs, runs and even other tables
        // Calling table.EnsureMinimum will also make sure that a table has at least one row, cell and paragraph
        Row firstRow = new Row(doc);
        table.appendChild(firstRow);
        
        Cell firstCell = new Cell(doc);
        firstRow.appendChild(firstCell);
        
        Paragraph paragraph = new Paragraph(doc);
        firstCell.appendChild(paragraph);
        
        Run run = new Run(doc, "Hello world!");
        paragraph.appendChild(run);
        
        doc.save(getArtifactsDir() + "Table.CreateTable.docx");
    • Property Getters/Setters Detail

      • getAbsoluteHorizontalDistance/setAbsoluteHorizontalDistance

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

        Example:

        Shows how set the location of floating tables.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a table
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Table 1, cell 1");
        builder.endTable();
        table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
        
        // We can set the table's location to a place on the page, such as the bottom right corner
        table.setRelativeVerticalAlignment(VerticalAlignment.BOTTOM);
        table.setRelativeHorizontalAlignment(HorizontalAlignment.RIGHT);
        
        table = builder.startTable();
        builder.insertCell();
        builder.write("Table 2, cell 1");
        builder.endTable();
        table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
        
        // We can also set a horizontal and vertical offset from the location in the paragraph where the table was inserted 
        table.setAbsoluteVerticalDistance(50.0);
        table.setAbsoluteHorizontalDistance(100.0);
        
        doc.save(getArtifactsDir() + "Table.ChangeFloatingTableProperties.docx");
      • getAbsoluteVerticalDistance/setAbsoluteVerticalDistance

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

        Example:

        Shows how set the location of floating tables.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a table
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Table 1, cell 1");
        builder.endTable();
        table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
        
        // We can set the table's location to a place on the page, such as the bottom right corner
        table.setRelativeVerticalAlignment(VerticalAlignment.BOTTOM);
        table.setRelativeHorizontalAlignment(HorizontalAlignment.RIGHT);
        
        table = builder.startTable();
        builder.insertCell();
        builder.write("Table 2, cell 1");
        builder.endTable();
        table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
        
        // We can also set a horizontal and vertical offset from the location in the paragraph where the table was inserted 
        table.setAbsoluteVerticalDistance(50.0);
        table.setAbsoluteHorizontalDistance(100.0);
        
        doc.save(getArtifactsDir() + "Table.ChangeFloatingTableProperties.docx");
      • 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() + "Tables.docx");
        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 and shading from the table
        table.clearBorders();
        table.clearShading();
        
        // 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(getArtifactsDir() + "Table.SetOutlineBorders.docx");
      • 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.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.getCellFormat().setPreferredWidth(PreferredWidth.fromPoints(100.0));
        builder.write(
                "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
        
        builder.insertCell();
        builder.getCellFormat().setPreferredWidth(PreferredWidth.AUTO);
        builder.write(
                "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
        builder.endRow();
        builder.endTable();
        
        table.setAllowAutoFit(allowAutoFit);
        
        doc.save(getArtifactsDir() + "Table.AllowAutoFitOnTable.html");
        See Also:
        autoFit(int)
      • getAllowCellSpacing/setAllowCellSpacing

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

        Example:

        Shows how to enable spacing between individual cells in a table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Animal");
        builder.insertCell();
        builder.write("Class");
        builder.endRow();
        builder.insertCell();
        builder.write("Dog");
        builder.insertCell();
        builder.write("Mammal");
        builder.endTable();
        
        // Set the size of padding space between cells, and the switch that enables/negates this setting
        table.setCellSpacing(3.0);
        table.setAllowCellSpacing(allowCellSpacing);
        
        doc.save(getArtifactsDir() + "Table.AllowCellSpacing.html");
      • 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 to work with floating tables properties.
        Document doc = new Document(getMyDir() + "Table wrapped by text.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        if (table.getTextWrapping() == TextWrapping.AROUND) {
            Assert.assertEquals(TextWrapping.AROUND, table.getTextWrapping());
            Assert.assertEquals(RelativeHorizontalPosition.MARGIN, table.getHorizontalAnchor());
            Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, table.getVerticalAnchor());
            Assert.assertEquals(false, table.getAllowOverlap());
        
            // Only Margin, Page, Column available in RelativeHorizontalPosition for HorizontalAnchor setter
            // The ArgumentException will be thrown for any other values
            table.setHorizontalAnchor(RelativeHorizontalPosition.COLUMN);
            // Only Margin, Page, Paragraph available in RelativeVerticalPosition for VerticalAnchor setter
            // The ArgumentException will be thrown for any other values
            table.setVerticalAnchor(RelativeVerticalPosition.PAGE);
        
        }
      • 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.

        Example:

        Shows how to create custom style settings for the table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Name");
        builder.insertCell();
        builder.write("مرحبًا");
        builder.endRow();
        builder.insertCell();
        builder.insertCell();
        builder.endTable();
        
        TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
        tableStyle.setAllowBreakAcrossPages(true);
        tableStyle.setBidi(true);
        tableStyle.setCellSpacing(5.0);
        tableStyle.setBottomPadding(20.0);
        tableStyle.setLeftPadding(5.0);
        tableStyle.setRightPadding(10.0);
        tableStyle.setTopPadding(20.0);
        tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
        tableStyle.getBorders().setColor(Color.BLACK);
        tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
        
        table.setStyle(tableStyle);
        
        // Some Table attributes are linked to style variables
        Assert.assertEquals(table.getBidi(), true);
        Assert.assertEquals(table.getCellSpacing(), 5.0);
        Assert.assertEquals(table.getStyleName(), "MyTableStyle1");
        
        doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");
      • 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 configure content padding in a table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Row 1, cell 1.");
        builder.insertCell();
        builder.write("Row 1, cell 2.");
        builder.endTable();
        
        // For every cell in the table, set the distance between its contents, and each of its borders. 
        // Text will be wrapped to maintain this minimum padding distance.
        table.setLeftPadding(30.0);
        table.setRightPadding(60.0);
        table.setTopPadding(10.0);
        table.setBottomPadding(90.0);
        table.setPreferredWidth(PreferredWidth.fromPoints(250.0));
        
        doc.save(getArtifactsDir() + "DocumentBuilder.SetRowFormatting.docx");
      • getCellSpacing/setCellSpacing

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

        Example:

        Shows how to enable spacing between individual cells in a table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Animal");
        builder.insertCell();
        builder.write("Class");
        builder.endRow();
        builder.insertCell();
        builder.write("Dog");
        builder.insertCell();
        builder.write("Mammal");
        builder.endTable();
        
        // Set the size of padding space between cells, and the switch that enables/negates this setting
        table.setCellSpacing(3.0);
        table.setAllowCellSpacing(allowCellSpacing);
        
        doc.save(getArtifactsDir() + "Table.AllowCellSpacing.html");

        Example:

        Shows how to create custom style settings for the table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Name");
        builder.insertCell();
        builder.write("مرحبًا");
        builder.endRow();
        builder.insertCell();
        builder.insertCell();
        builder.endTable();
        
        TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
        tableStyle.setAllowBreakAcrossPages(true);
        tableStyle.setBidi(true);
        tableStyle.setCellSpacing(5.0);
        tableStyle.setBottomPadding(20.0);
        tableStyle.setLeftPadding(5.0);
        tableStyle.setRightPadding(10.0);
        tableStyle.setTopPadding(20.0);
        tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
        tableStyle.getBorders().setColor(Color.BLACK);
        tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
        
        table.setStyle(tableStyle);
        
        // Some Table attributes are linked to style variables
        Assert.assertEquals(table.getBidi(), true);
        Assert.assertEquals(table.getCellSpacing(), 5.0);
        Assert.assertEquals(table.getStyleName(), "MyTableStyle1");
        
        doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");
      • getChildNodes

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

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

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

        Example:

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

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

        Example:

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

        Example:

        Shows how to build a nested table without using DocumentBuilder.
        public void createNestedTable() 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(getArtifactsDir() + "Table.CreateNestedTable.docx");
        }
        
        /**
         * Creates a new table in the document with the given dimensions and text in each cell.
         */
        private Table createTable(final Document doc, final int rowCount, final int cellCount, final String cellText) throws Exception {
            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));
                }
            }
        
            // You can add title and description to your table only when added at least one row to the table first
            // This properties are meaningful for ISO / IEC 29500 compliant DOCX documents(see the OoxmlCompliance class)
            // When saved to pre-ISO/IEC 29500 formats, the properties are ignored
            table.setTitle("Aspose table title");
            table.setDescription("Aspose table description");
        
            return table;
        }
      • getDistanceBottom

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

        Example:

        Shows the minimum distance operations between table boundaries and text.
        Document doc = new Document(getMyDir() + "Table wrapped by text.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        Assert.assertEquals(table.getDistanceTop(), 25.9d);
        Assert.assertEquals(table.getDistanceBottom(), 25.9d);
        Assert.assertEquals(table.getDistanceLeft(), 17.3d);
        Assert.assertEquals(table.getDistanceRight(), 17.3d);
      • getDistanceLeft

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

        Example:

        Shows the minimum distance operations between table boundaries and text.
        Document doc = new Document(getMyDir() + "Table wrapped by text.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        Assert.assertEquals(table.getDistanceTop(), 25.9d);
        Assert.assertEquals(table.getDistanceBottom(), 25.9d);
        Assert.assertEquals(table.getDistanceLeft(), 17.3d);
        Assert.assertEquals(table.getDistanceRight(), 17.3d);
      • getDistanceRight

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

        Example:

        Shows the minimum distance operations between table boundaries and text.
        Document doc = new Document(getMyDir() + "Table wrapped by text.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        Assert.assertEquals(table.getDistanceTop(), 25.9d);
        Assert.assertEquals(table.getDistanceBottom(), 25.9d);
        Assert.assertEquals(table.getDistanceLeft(), 17.3d);
        Assert.assertEquals(table.getDistanceRight(), 17.3d);
      • getDistanceTop

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

        Example:

        Shows the minimum distance operations between table boundaries and text.
        Document doc = new Document(getMyDir() + "Table wrapped by text.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        Assert.assertEquals(table.getDistanceTop(), 25.9d);
        Assert.assertEquals(table.getDistanceBottom(), 25.9d);
        Assert.assertEquals(table.getDistanceLeft(), 17.3d);
        Assert.assertEquals(table.getDistanceRight(), 17.3d);
      • getDocument

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

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

        Example:

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

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

        Example:

        Shows how to enumerate immediate child nodes of a composite node using NextSibling.
        Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
        // Loop starting from the first child until we reach null
        for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) {
            // Output the types of the nodes that we come across
            System.out.println(Node.nodeTypeToString(node.getNodeType()));
        }

        Example:

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

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

        Example:

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

        Example:

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

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

        Example:

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

        public int getHorizontalAnchor() / public void setHorizontalAnchor(int value)
        
        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 to work with floating tables properties.
        Document doc = new Document(getMyDir() + "Table wrapped by text.docx");
        
        Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        
        if (table.getTextWrapping() == TextWrapping.AROUND) {
            Assert.assertEquals(TextWrapping.AROUND, table.getTextWrapping());
            Assert.assertEquals(RelativeHorizontalPosition.MARGIN, table.getHorizontalAnchor());
            Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, table.getVerticalAnchor());
            Assert.assertEquals(false, table.getAllowOverlap());
        
            // Only Margin, Page, Column available in RelativeHorizontalPosition for HorizontalAnchor setter
            // The ArgumentException will be thrown for any other values
            table.setHorizontalAnchor(RelativeHorizontalPosition.COLUMN);
            // Only Margin, Page, Paragraph available in RelativeVerticalPosition for VerticalAnchor setter
            // The ArgumentException will be thrown for any other values
            table.setVerticalAnchor(RelativeVerticalPosition.PAGE);
        
        }
      • isComposite

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

        Example:

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

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

        Example:

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

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

        Example:

        Shows how to use typed properties to access nodes of the document tree.
        Document doc = new Document(getMyDir() + "Tables.docx");
        
        // Quick typed access to all Table child nodes contained in the Body
        TableCollection tables = doc.getFirstSection().getBody().getTables();
        
        Assert.assertEquals(5, tables.get(0).getRows().getCount());
        Assert.assertEquals(4, tables.get(1).getRows().getCount());
        
        for (Table table : tables) {
            // Quick typed access to the first row of the table
            if (table.getFirstRow() != null) {
                table.getFirstRow().remove();
            }
        
            // Quick typed access to the last row of the table
            if (table.getLastRow() != null) {
                table.getLastRow().remove();
            }
        }
        
        // Each table has shrunk by two rows
        Assert.assertEquals(3, tables.get(0).getRows().getCount());
        Assert.assertEquals(2, tables.get(1).getRows().getCount());
      • 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();
        builder.insertCell();
        table.setLeftIndent(20.0);
        
        // Set some formatting options for text and table appearance.
        builder.getRowFormat().setHeight(40.0);
        builder.getRowFormat().setHeightRule(HeightRule.AT_LEAST);
        builder.getCellFormat().getShading().setBackgroundPatternColor(new Color((198), (217), (241)));
        
        builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        builder.getFont().setSize(16.0);
        builder.getFont().setName("Arial");
        builder.getFont().setBold(true);
        
        // Configuring the formatting options in a document builder will apply them
        // to the current cell/row its cursor is in,
        // as well as any new cells and rows created using that builder.
        builder.write("Header Row,\n Cell 1");
        builder.insertCell();
        builder.write("Header Row,\n Cell 2");
        builder.insertCell();
        builder.write("Header Row,\n Cell 3");
        builder.endRow();
        
        // Reconfigure the builder's formatting objects for new rows and cells that we are about to make.
        // The builder will not apply these to the first row already created so that it will stand out as a header row.
        builder.getCellFormat().getShading().setBackgroundPatternColor(Color.WHITE);
        builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER);
        builder.getRowFormat().setHeight(30.0);
        builder.getRowFormat().setHeightRule(HeightRule.AUTO);
        builder.insertCell();
        builder.getFont().setSize(12.0);
        builder.getFont().setBold(false);
        
        builder.write("Row 1, Cell 1.");
        builder.insertCell();
        builder.write("Row 1, Cell 2.");
        builder.insertCell();
        builder.write("Row 1, Cell 3.");
        builder.endRow();
        builder.insertCell();
        builder.write("Row 2, Cell 1.");
        builder.insertCell();
        builder.write("Row 2, Cell 2.");
        builder.insertCell();
        builder.write("Row 2, Cell 3.");
        builder.endRow();
        builder.endTable();
        
        doc.save(getArtifactsDir() + "DocumentBuilder.CreateFormattedTable.docx");
      • 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 configure content padding in a table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Row 1, cell 1.");
        builder.insertCell();
        builder.write("Row 1, cell 2.");
        builder.endTable();
        
        // For every cell in the table, set the distance between its contents, and each of its borders. 
        // Text will be wrapped to maintain this minimum padding distance.
        table.setLeftPadding(30.0);
        table.setRightPadding(60.0);
        table.setTopPadding(10.0);
        table.setBottomPadding(90.0);
        table.setPreferredWidth(PreferredWidth.fromPoints(250.0));
        
        doc.save(getArtifactsDir() + "DocumentBuilder.SetRowFormatting.docx");
      • getNextSibling

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

        Example:

        Shows how to enumerate immediate child nodes of a composite node using NextSibling.
        Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
        // Loop starting from the first child until we reach null
        for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) {
            // Output the types of the nodes that we come across
            System.out.println(Node.nodeTypeToString(node.getNodeType()));
        }

        Example:

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

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

        Example:

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

        Example:

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

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

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

        Example:

        Shows how to access the parent node.
        Document doc = new Document();
        
        // Get the document's first paragraph and append a child node to it in the form of a run with text
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // When inserting a new node, the document that the node will belong to must be provided as an argument
        Run run = new Run(doc, "Hello world!");
        para.appendChild(run);
        
        // The node lineage can be traced back to the document itself
        Assert.assertEquals(para, run.getParentNode());
        Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
        Assert.assertEquals(doc.getFirstSection(), doc.getFirstSection().getBody().getParentNode());
        Assert.assertEquals(doc, doc.getFirstSection().getParentNode());

        Example:

        Shows how to create a node and set its owning document.
        // Open a file from disk
        Document doc = new Document();
        
        // Creating a new node of any type requires a document passed into the constructor
        Paragraph para = new Paragraph(doc);
        
        // The new paragraph node does not yet have a parent
        System.out.println("Paragraph has no parent node: " + (para.getParentNode() == null));
        
        // But the paragraph node knows its document
        System.out.println("Both nodes' documents are the same: " + (para.getDocument() == doc));
        
        // The fact that a node always belongs to a document allows us to access and modify 
        // properties that reference the document-wide data such as styles or lists
        para.getParagraphFormat().setStyleName("Heading 1");
        
        // Now add the paragraph to the main text of the first section
        doc.getFirstSection().getBody().appendChild(para);
        
        // The paragraph node is now a child of the Body node
        System.out.println("Paragraph has a parent node: " + (para.getParentNode() != null));
      • 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 width of the page.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Cell #1");
        builder.insertCell();
        builder.write("Cell #2");
        builder.insertCell();
        builder.write("Cell #3");
        
        table.setPreferredWidth(PreferredWidth.fromPercent(50.0));
        
        doc.save(getArtifactsDir() + "DocumentBuilder.InsertTableWithPreferredWidth.docx");
      • getPreviousSibling

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

        Example:

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

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

        Example:

        Shows how to delete all characters of a range.
        // Insert two sections into a blank document
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.write("Section 1. ");
        builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
        builder.write("Section 2.");
        
        // Verify the whole text of the document
        Assert.assertEquals("Section 1. \fSection 2.", doc.getText().trim());
        
        // Delete the first section from the document
        doc.getSections().get(0).getRange().delete();
        
        // Check the first section was deleted by looking at the text of the whole document again
        Assert.assertEquals("Section 2.", doc.getText().trim());
      • getRelativeHorizontalAlignment/setRelativeHorizontalAlignment

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

        Example:

        Shows how set the location of floating tables.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a table
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Table 1, cell 1");
        builder.endTable();
        table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
        
        // We can set the table's location to a place on the page, such as the bottom right corner
        table.setRelativeVerticalAlignment(VerticalAlignment.BOTTOM);
        table.setRelativeHorizontalAlignment(HorizontalAlignment.RIGHT);
        
        table = builder.startTable();
        builder.insertCell();
        builder.write("Table 2, cell 1");
        builder.endTable();
        table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
        
        // We can also set a horizontal and vertical offset from the location in the paragraph where the table was inserted 
        table.setAbsoluteVerticalDistance(50.0);
        table.setAbsoluteHorizontalDistance(100.0);
        
        doc.save(getArtifactsDir() + "Table.ChangeFloatingTableProperties.docx");
      • getRelativeVerticalAlignment/setRelativeVerticalAlignment

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

        Example:

        Shows how set the location of floating tables.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a table
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Table 1, cell 1");
        builder.endTable();
        table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
        
        // We can set the table's location to a place on the page, such as the bottom right corner
        table.setRelativeVerticalAlignment(VerticalAlignment.BOTTOM);
        table.setRelativeHorizontalAlignment(HorizontalAlignment.RIGHT);
        
        table = builder.startTable();
        builder.insertCell();
        builder.write("Table 2, cell 1");
        builder.endTable();
        table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
        
        // We can also set a horizontal and vertical offset from the location in the paragraph where the table was inserted 
        table.setAbsoluteVerticalDistance(50.0);
        table.setAbsoluteHorizontalDistance(100.0);
        
        doc.save(getArtifactsDir() + "Table.ChangeFloatingTableProperties.docx");
      • 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 configure content padding in a table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Row 1, cell 1.");
        builder.insertCell();
        builder.write("Row 1, cell 2.");
        builder.endTable();
        
        // For every cell in the table, set the distance between its contents, and each of its borders. 
        // Text will be wrapped to maintain this minimum padding distance.
        table.setLeftPadding(30.0);
        table.setRightPadding(60.0);
        table.setTopPadding(10.0);
        table.setBottomPadding(90.0);
        table.setPreferredWidth(PreferredWidth.fromPoints(250.0));
        
        doc.save(getArtifactsDir() + "DocumentBuilder.SetRowFormatting.docx");
      • 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() + "Tables.docx");
        
        // Get the first and second table in the document
        // The rows from the second table will be appended to the end of the first table
        Table firstTable = (Table) doc.getChild(NodeType.TABLE, 0, true);
        Table secondTable = (Table) doc.getChild(NodeType.TABLE, 1, true);
        
        // Append all rows from the current table to the next
        // Due to the design of tables even tables with different cell count and widths can be joined into one table
        while (secondTable.hasChildNodes())
            firstTable.getRows().add(secondTable.getFirstRow());
        
        // Remove the empty table container
        secondTable.remove();
        
        doc.save(getArtifactsDir() + "Table.CombineTables.docx");

        Example:

        Shows how to iterate through all tables in the document and display the content from each cell.
        Document doc = new Document(getMyDir() + "Tables.docx");
        
        // 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)
        TableCollection tables = doc.getFirstSection().getBody().getTables();
        
        // We can make a new array to clone all of the tables in the collection
        Assert.assertEquals(tables.toArray().length, 2);
        
        // Iterate through all tables in the document
        for (int i = 0; i < tables.getCount(); i++) {
            // Get the index of the table node as contained in the parent node of the table
            System.out.println(MessageFormat.format("Start of Table {0}", i));
        
            RowCollection rows = tables.get(i).getRows();
        
            // Iterate through all rows in the table
            for (int j = 0; j < rows.getCount(); j++) {
                System.out.println(MessageFormat.format("\tStart of Row {0}", j));
        
                CellCollection cells = rows.get(j).getCells();
        
                // Iterate through all cells in the row
                for (int k = 0; k < cells.getCount(); k++) {
                    // Get the plain text content of this cell.
                    String cellText = cells.get(k).toString(SaveFormat.TEXT).trim();
                    // Print the content of the cell.
                    System.out.println(MessageFormat.format("\t\tContents of Cell:{0} = \"{1}\"", k, cellText));
                }
        
                System.out.println(MessageFormat.format("\tEnd of Row {0}", j));
            }
        
            System.out.println(MessageFormat.format("End of Table {0}\n", i));
        }
      • getStyle/setStyle

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

        Example:

        Shows how to create custom style settings for the table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Name");
        builder.insertCell();
        builder.write("مرحبًا");
        builder.endRow();
        builder.insertCell();
        builder.insertCell();
        builder.endTable();
        
        TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
        tableStyle.setAllowBreakAcrossPages(true);
        tableStyle.setBidi(true);
        tableStyle.setCellSpacing(5.0);
        tableStyle.setBottomPadding(20.0);
        tableStyle.setLeftPadding(5.0);
        tableStyle.setRightPadding(10.0);
        tableStyle.setTopPadding(20.0);
        tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
        tableStyle.getBorders().setColor(Color.BLACK);
        tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
        
        table.setStyle(tableStyle);
        
        // Some Table attributes are linked to style variables
        Assert.assertEquals(table.getBidi(), true);
        Assert.assertEquals(table.getCellSpacing(), 5.0);
        Assert.assertEquals(table.getStyleName(), "MyTableStyle1");
        
        doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");
      • 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 while applying a style.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        Table table = builder.startTable();
        
        // We must insert at least one row before setting any table formatting.
        builder.insertCell();
        
        // Set the table style used based on the style identifier.
        // Note that not all table styles are available when saving to .doc format.
        table.setStyleIdentifier(StyleIdentifier.MEDIUM_SHADING_1_ACCENT_1);
        
        // Partially apply the style to features of the table based on predicates, then build the table.
        table.setStyleOptions(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW);
        table.autoFit(AutoFitBehavior.AUTO_FIT_TO_CONTENTS);
        
        builder.writeln("Item");
        builder.getCellFormat().setRightPadding(40.0);
        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(getArtifactsDir() + "DocumentBuilder.InsertTableWithStyle.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.

        Example:

        Shows how to create custom style settings for the table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Name");
        builder.insertCell();
        builder.write("مرحبًا");
        builder.endRow();
        builder.insertCell();
        builder.insertCell();
        builder.endTable();
        
        TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
        tableStyle.setAllowBreakAcrossPages(true);
        tableStyle.setBidi(true);
        tableStyle.setCellSpacing(5.0);
        tableStyle.setBottomPadding(20.0);
        tableStyle.setLeftPadding(5.0);
        tableStyle.setRightPadding(10.0);
        tableStyle.setTopPadding(20.0);
        tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
        tableStyle.getBorders().setColor(Color.BLACK);
        tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
        
        table.setStyle(tableStyle);
        
        // Some Table attributes are linked to style variables
        Assert.assertEquals(table.getBidi(), true);
        Assert.assertEquals(table.getCellSpacing(), 5.0);
        Assert.assertEquals(table.getStyleName(), "MyTableStyle1");
        
        doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");
      • 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 while applying a style.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        Table table = builder.startTable();
        
        // We must insert at least one row before setting any table formatting.
        builder.insertCell();
        
        // Set the table style used based on the style identifier.
        // Note that not all table styles are available when saving to .doc format.
        table.setStyleIdentifier(StyleIdentifier.MEDIUM_SHADING_1_ACCENT_1);
        
        // Partially apply the style to features of the table based on predicates, then build the table.
        table.setStyleOptions(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW);
        table.autoFit(AutoFitBehavior.AUTO_FIT_TO_CONTENTS);
        
        builder.writeln("Item");
        builder.getCellFormat().setRightPadding(40.0);
        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(getArtifactsDir() + "DocumentBuilder.InsertTableWithStyle.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.

        Example:

        Shows how to work with table text wrapping.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a table and a paragraph of text after it
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Cell 1");
        builder.insertCell();
        builder.write("Cell 2");
        builder.endTable();
        table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
        
        builder.getFont().setSize(16.0);
        builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
        
        // Set the table to wrap text around it and push it down into the paragraph below be setting the position
        table.setTextWrapping(TextWrapping.AROUND);
        table.setAbsoluteHorizontalDistance(100.0);
        table.setAbsoluteVerticalDistance(20.0);
        
        doc.save(getArtifactsDir() + "Table.WrapText.docx");
      • 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.

        Example:

        Shows how to build a nested table without using DocumentBuilder.
        public void createNestedTable() 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(getArtifactsDir() + "Table.CreateNestedTable.docx");
        }
        
        /**
         * Creates a new table in the document with the given dimensions and text in each cell.
         */
        private Table createTable(final Document doc, final int rowCount, final int cellCount, final String cellText) throws Exception {
            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));
                }
            }
        
            // You can add title and description to your table only when added at least one row to the table first
            // This properties are meaningful for ISO / IEC 29500 compliant DOCX documents(see the OoxmlCompliance class)
            // When saved to pre-ISO/IEC 29500 formats, the properties are ignored
            table.setTitle("Aspose table title");
            table.setDescription("Aspose table description");
        
            return table;
        }
      • 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 configure content padding in a table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Row 1, cell 1.");
        builder.insertCell();
        builder.write("Row 1, cell 2.");
        builder.endTable();
        
        // For every cell in the table, set the distance between its contents, and each of its borders. 
        // Text will be wrapped to maintain this minimum padding distance.
        table.setLeftPadding(30.0);
        table.setRightPadding(60.0);
        table.setTopPadding(10.0);
        table.setBottomPadding(90.0);
        table.setPreferredWidth(PreferredWidth.fromPoints(250.0));
        
        doc.save(getArtifactsDir() + "DocumentBuilder.SetRowFormatting.docx");
      • getVerticalAnchor/setVerticalAnchor

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

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

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

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

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

        Example:

        Shows how to construct an Aspose Words document node by node.
        Document doc = new Document();
        
        // A newly created blank document still comes one section, one body and one paragraph
        // Calling this method will remove all those nodes to completely empty the document
        doc.removeAllChildren();
        
        // This document now has no composite nodes that content can be added to
        // If we wish to edit it, we will need to repopulate its node collection,
        // which we will start to do with by creating a new Section node
        Section section = new Section(doc);
        
        // Append the section to the document
        doc.appendChild(section);
        
        // Lets set some properties for the section
        section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
        section.getPageSetup().setPaperSize(PaperSize.LETTER);
        
        // A section needs a body, which will contain all other nodes that can be edited
        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);
        
        // Now we can begin adding content to the document
        Run run = new Run(doc);
        run.setText("Hello World!");
        run.getFont().setColor(Color.RED);
        para.appendChild(run);
        
        Assert.assertEquals("Hello World!" + ControlChar.SECTION_BREAK_CHAR, doc.getText());
        
        doc.save(getArtifactsDir() + "Section.CreateFromScratch.docx");
      • 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 while applying a style.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        Table table = builder.startTable();
        
        // We must insert at least one row before setting any table formatting.
        builder.insertCell();
        
        // Set the table style used based on the style identifier.
        // Note that not all table styles are available when saving to .doc format.
        table.setStyleIdentifier(StyleIdentifier.MEDIUM_SHADING_1_ACCENT_1);
        
        // Partially apply the style to features of the table based on predicates, then build the table.
        table.setStyleOptions(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW);
        table.autoFit(AutoFitBehavior.AUTO_FIT_TO_CONTENTS);
        
        builder.writeln("Item");
        builder.getCellFormat().setRightPadding(40.0);
        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(getArtifactsDir() + "DocumentBuilder.InsertTableWithStyle.docx");
      • clearBorders

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

        Example:

        Shows how to remove all borders from a table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create a table
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Hello world!");
        builder.endTable();
        
        // Set a color/thickness for the top border of the first row and verify the values
        Border topBorder = table.getFirstRow().getRowFormat().getBorders().getByBorderType(BorderType.TOP);
        table.setBorder(BorderType.TOP, LineStyle.DOUBLE, 1.5, Color.RED, true);
        
        Assert.assertEquals(1.5d, topBorder.getLineWidth());
        Assert.assertEquals(Color.RED.getRGB(), topBorder.getColor().getRGB());
        Assert.assertEquals(LineStyle.DOUBLE, topBorder.getLineStyle());
        
        // Clear the borders all cells in the table
        table.clearBorders();
        doc.save(getArtifactsDir() + "Table.ClearBorders.docx");
        
        // Upon re-opening the saved document, the new border attributes can be verified
        doc = new Document(getArtifactsDir() + "Table.ClearBorders.docx");
        table = (Table) doc.getChild(NodeType.TABLE, 0, true);
        topBorder = table.getFirstRow().getRowFormat().getBorders().getByBorderType(BorderType.TOP);
        
        Assert.assertEquals(0.0d, topBorder.getLineWidth());
        Assert.assertEquals(0, topBorder.getColor().getRGB());
        Assert.assertEquals(LineStyle.NONE, topBorder.getLineStyle());

        Example:

        Shows how to apply a outline border to a table.
        Document doc = new Document(getMyDir() + "Tables.docx");
        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 and shading from the table
        table.clearBorders();
        table.clearShading();
        
        // 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(getArtifactsDir() + "Table.SetOutlineBorders.docx");
      • clearShading

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

        Example:

        Shows how to apply a outline border to a table.
        Document doc = new Document(getMyDir() + "Tables.docx");
        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 and shading from the table
        table.clearBorders();
        table.clearShading();
        
        // 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(getArtifactsDir() + "Table.SetOutlineBorders.docx");
      • convertToHorizontallyMergedCells

        public void convertToHorizontallyMergedCells()
        Converts cells horizontally merged by width to cells merged by CellFormat.HorizontalMerge.

        Table cells can be horizontally merged either using merge flags CellFormat.HorizontalMerge or using cell width CellFormat.Width.

        When table cell is merged by width property CellFormat.HorizontalMerge is meaningless but sometimes having merge flags is more convenient way.

        Use this method to transforms table cells horizontally merged by width to cells merged by merge flags.

        Example:

        Shows how to convert cells horizontally merged by width to cells merged by CellFormat.HorizontalMerge.
        Document doc = new Document(getMyDir() + "Table with merged cells.docx");
        
        // MS Word does not write merge flags anymore, they define merged cells by its width
        // So AW by default define only 5 cells in a row and all of it didn't have horizontal merge flag
        Table table = doc.getFirstSection().getBody().getTables().get(0);
        Row row = table.getRows().get(0);
        Assert.assertEquals(row.getCells().getCount(), 5);
        
        // To resolve this inconvenience, we have added new public method to convert cells which are horizontally merged
        // by its width to the cell horizontally merged by flags. Thus now we have 7 cells and some of them have
        // horizontal merge value
        table.convertToHorizontallyMergedCells();
        row = table.getRows().get(0);
        Assert.assertEquals(row.getCells().getCount(), 7);
        
        Assert.assertEquals(row.getCells().get(0).getCellFormat().getHorizontalMerge(), CellMerge.NONE);
        Assert.assertEquals(row.getCells().get(1).getCellFormat().getHorizontalMerge(), CellMerge.FIRST);
        Assert.assertEquals(row.getCells().get(2).getCellFormat().getHorizontalMerge(), CellMerge.PREVIOUS);
        Assert.assertEquals(row.getCells().get(3).getCellFormat().getHorizontalMerge(), CellMerge.NONE);
        Assert.assertEquals(row.getCells().get(4).getCellFormat().getHorizontalMerge(), CellMerge.FIRST);
        Assert.assertEquals(row.getCells().get(5).getCellFormat().getHorizontalMerge(), CellMerge.PREVIOUS);
        Assert.assertEquals(row.getCells().get(6).getCellFormat().getHorizontalMerge(), CellMerge.NONE);
      • deepClone

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

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

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

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

        Example:

        Shows how to clone composite nodes with and without their child nodes.
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        para.appendChild(new Run(doc, "Hello world!"));
        
        // Clone the paragraph and the child nodes
        Node cloneWithChildren = para.deepClone(true);
        
        Assert.assertTrue(((CompositeNode) cloneWithChildren).hasChildNodes());
        Assert.assertEquals("Hello world!", cloneWithChildren.getText().trim());
        
        // Clone the paragraph without its clild nodes
        Node cloneWithoutChildren = para.deepClone(false);
        
        Assert.assertFalse(((CompositeNode) cloneWithoutChildren).hasChildNodes());
        Assert.assertEquals("", cloneWithoutChildren.getText().trim());
      • 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);
        
        // Currently, the table does not contain any rows, cells or nodes that can have content added to them
        Assert.assertEquals(0, table.getChildNodes(NodeType.ANY, true).getCount());
        
        // This method ensures that the table has one row, one cell and one paragraph; the minimal nodes required to begin editing
        table.ensureMinimum();
        table.getFirstRow().getFirstCell().getFirstParagraph().appendChild(new Run(doc, "Hello world!"));
      • getAncestor

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

        Example:

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

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

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

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

        Example:

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

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

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

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

        Example:

        Shows how to apply attributes of a table's style directly to the table's elements.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Table table = builder.startTable();
        builder.insertCell();
        builder.write("Hello world!");
        builder.endTable();
        
        TableStyle tableStyle = (TableStyle)doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
        tableStyle.setRowStripe(3);
        tableStyle.setCellSpacing(5.0);
        tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
        tableStyle.getBorders().setColor(Color.BLUE);
        tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
        
        table.setStyle(tableStyle);
        
        // This method concerns table style attributes such as the ones we set above.
        doc.expandTableStylesToDirectFormatting();
        
        doc.save(getArtifactsDir() + "Document.TableStyleToDirectFormatting.docx");

        Example:

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

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

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

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

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

        Example:

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

        Example:

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

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

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

        Example:

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

        Example:

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

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

        Example:

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

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

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

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

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

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

        Example:

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

        Example:

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

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

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

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

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

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

        Example:

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

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

        Example:

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

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

        Example:

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

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

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

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

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

        Example:

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

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

        Example:

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

        public void remove()
        Removes itself from the parent.

        Example:

        Shows how to delete all images from a document.
        Document doc = new Document(getMyDir() + "Images.docx");
        Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10);
        
        // Here we get all shapes from the document node, but you can do this for any smaller
        // node too, for example delete shapes from a single section or a paragraph
        NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
        
        // We cannot delete shape nodes while we enumerate through the collection
        // One solution is to add nodes that we want to delete to a temporary array and delete afterwards
        ArrayList shapesToDelete = new ArrayList();
        for (Shape shape : (Iterable<Shape>) shapes) {
            // Several shape types can have an image including image shapes and OLE objects
            if (shape.hasImage()) {
                shapesToDelete.add(shape);
            }
        }
        
        // Now we can delete shapes
        for (Shape shape : (Iterable<Shape>) shapesToDelete)
            shape.remove();
        
        // The only remaining shape doesn't have an image
        Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
        Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());

        Example:

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

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

        Example:

        Shows how to construct an Aspose Words document node by node.
        Document doc = new Document();
        
        // A newly created blank document still comes one section, one body and one paragraph
        // Calling this method will remove all those nodes to completely empty the document
        doc.removeAllChildren();
        
        // This document now has no composite nodes that content can be added to
        // If we wish to edit it, we will need to repopulate its node collection,
        // which we will start to do with by creating a new Section node
        Section section = new Section(doc);
        
        // Append the section to the document
        doc.appendChild(section);
        
        // Lets set some properties for the section
        section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
        section.getPageSetup().setPaperSize(PaperSize.LETTER);
        
        // A section needs a body, which will contain all other nodes that can be edited
        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);
        
        // Now we can begin adding content to the document
        Run run = new Run(doc);
        run.setText("Hello World!");
        run.getFont().setColor(Color.RED);
        para.appendChild(run);
        
        Assert.assertEquals("Hello World!" + ControlChar.SECTION_BREAK_CHAR, doc.getText());
        
        doc.save(getArtifactsDir() + "Section.CreateFromScratch.docx");
      • removeChild

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

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

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

        Example:

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

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

        Example:

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

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

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

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

        Example:

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

        Example:

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

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

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

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

        Example:

        Shows how to select certain nodes by using an XPath expression.
        Document doc = new Document(getMyDir() + "Tables.docx");
        
        // This expression will extract all paragraph nodes which are descendants of any table node in the document
        // This will return any paragraphs which are in a table
        NodeList nodeList = doc.selectNodes("//Table//Paragraph");
        
        // Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table
        int index = 0;
        
        Iterator<Node> e = nodeList.iterator();
        while (e.hasNext()) {
            Node currentNode = e.next();
            System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim()));
        }
        
        // This expression will select any paragraphs that are direct children of any body node in the document
        nodeList = doc.selectNodes("//Body/Paragraph");
        
        // We can treat the list as an array too
        Assert.assertEquals(nodeList.toArray().length, 4);
        
        // Use SelectSingleNode to select the first result of the same expression as above
        Node node = doc.selectSingleNode("//Body/Paragraph");
        
        Assert.assertEquals(Paragraph.class, node.getClass());
      • 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() + "Tables.docx");
        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 and shading from the table
        table.clearBorders();
        table.clearShading();
        
        // 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(getArtifactsDir() + "Table.SetOutlineBorders.docx");
      • 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 apply border and shading color while building a table.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Start a table, and set a default color/thickness for its borders.
        Table table = builder.startTable();
        table.setBorders(LineStyle.SINGLE, 2.0, Color.BLACK);
        
        // Create a row with two cells with different background colors.
        builder.insertCell();
        builder.getCellFormat().getShading().setBackgroundPatternColor(Color.RED);
        builder.writeln("Row 1, Cell 1.");
        builder.insertCell();
        builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN);
        builder.writeln("Row 1, Cell 2.");
        builder.endRow();
        
        // Reset cell formatting to disable the background colors
        // set a custom border thickness for all new cells created by the builder,
        // then build a second row.
        builder.getCellFormat().clearFormatting();
        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.insertCell();
        builder.writeln("Row 2, Cell 1.");
        builder.insertCell();
        builder.writeln("Row 2, Cell 2.");
        
        doc.save(getArtifactsDir() + "DocumentBuilder.TableBordersAndShading.docx");

        Example:

        Shows how to build a table with all borders enabled (grid).
        Document doc = new Document(getMyDir() + "Tables.docx");
        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(getArtifactsDir() + "Table.SetAllBorders.docx");
      • 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() + "Tables.docx");
        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 and shading from the table
        table.clearBorders();
        table.clearShading();
        
        // 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(getArtifactsDir() + "Table.SetOutlineBorders.docx");
      • toString

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

        Example:

        Exports the content of a node to String in HTML format.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        // Extract the last paragraph in the document to convert to HTML
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When ToString is called using the html SaveFormat overload then the node is converted directly to html
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(SaveFormat.HTML));
        
        // We can also modify the result of this conversion using a SaveOptions object
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setExportRelativeFontSize(true);
        
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(saveOptions));
      • toString

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

        Example:

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

        Example:

        Exports the content of a node to String in HTML format.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        // Extract the last paragraph in the document to convert to HTML
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When ToString is called using the html SaveFormat overload then the node is converted directly to html
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(SaveFormat.HTML));
        
        // We can also modify the result of this conversion using a SaveOptions object
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setExportRelativeFontSize(true);
        
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(saveOptions));

        Example:

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