com.aspose.words

Constructor Detail

• Row

  public Row(DocumentBase doc)

  Initializes a new instance of the Row class.

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

  To append Row to the document use InsertAfter or InsertBefore on the table where you want the row 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;
  }

Property Getters/Setters Detail

• getCells

  public CellCollection getCells()
  

  Provides typed access to the Cell child nodes of the row.

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

• getChildNodes

  public NodeCollection getChildNodes()
  

  Gets all immediate child nodes of this node.

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

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

  Example:

  Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.

  Document doc = new Document();
  
  Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
  paragraph.appendChild(new Run(doc, "Hello world!"));
  paragraph.appendChild(new Run(doc, " Hello again!"));
  
  NodeCollection children = paragraph.getChildNodes();
  
  // Paragraph may contain children of various types such as runs, shapes and so on
  for (Node child : (Iterable<Node>) children)
      if (((child.getNodeType()) == (NodeType.RUN))) {
          Run run = (Run) child;
          System.out.println(run.getText());
      }

• getCount

  public int getCount()
  

  Gets the number of immediate children of this node.

  Example:

  Shows how to add, update and delete child nodes from a CompositeNode's child collection.

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

• getDocument

  public DocumentBase getDocument()
  

  Gets the document to which this node belongs.

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

  Example:

  Shows how to create a node and set its owning document.

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

• getFirstCell

  public Cell getFirstCell()
  

  Returns the first Cell in the row.

  Example:

  Shows how to print the node structure of every table in a document.

  public void tableToText() throws Exception {
      Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
      TableStructurePrinter visitor = new TableStructurePrinter();
  
      // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
      // and then traverses all of the node's children in a depth-first manner.
      // The visitor can read and modify each visited node.
      doc.accept(visitor);
  
      System.out.println(visitor.getText());
  }
  
  /// <summary>
  /// Traverses a node's non-binary tree of child nodes.
  /// Creates a map in the form of a string of all encountered Table nodes and their children.
  /// </summary>
  public static class TableStructurePrinter extends DocumentVisitor {
      public TableStructurePrinter() {
          mVisitedTables = new StringBuilder();
          mVisitorIsInsideTable = false;
      }
  
      public String getText() {
          return mVisitedTables.toString();
      }
  
      /// <summary>
      /// Called when a Run node is encountered in the document.
      /// Runs that are not within tables are not recorded.
      /// </summary>
      public /*override*/ /*VisitorAction*/int visitRun(Run run) {
          if (mVisitorIsInsideTable) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Table is encountered in the document.
      /// </summary>
      public int visitTableStart(final Table table) {
          int rows = 0;
          int columns = 0;
  
          if (table.getRows().getCount() > 0) {
              rows = table.getRows().getCount();
              columns = table.getFirstRow().getCount();
          }
  
          indentAndAppendLine("[Table start] Size: " + rows + "x" + columns);
          mDocTraversalDepth++;
          mVisitorIsInsideTable = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Table node have been visited.
      /// </summary>
      public int visitTableEnd(final Table table) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Table end]");
          mVisitorIsInsideTable = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Row node is encountered in the document.
      /// </summary>
      public int visitRowStart(final Row row) {
          String rowContents = row.getText().replaceAll("\\u0007", ", ").replaceAll(", , ", "");
          int rowWidth = row.indexOf(row.getLastCell()) + 1;
          int rowIndex = row.getParentTable().indexOf(row);
          String rowStatusInTable = row.isFirstRow() && row.isLastRow() ? "only" : row.isFirstRow() ? "first" : row.isLastRow() ? "last" : "";
          if (!"".equals(rowStatusInTable)) {
              rowStatusInTable = MessageFormat.format(", the {0} row in this table,", rowStatusInTable);
          }
  
          indentAndAppendLine(MessageFormat.format("[Row start] Row #{0}{1} width {2}, \"{3}\"", ++rowIndex, rowStatusInTable, rowWidth, rowContents));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Row node have been visited.
      /// </summary>
      public int visitRowEnd(final Row row) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Row end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Cell node is encountered in the document.
      /// </summary>
      public int visitCellStart(final Cell cell) {
          Row row = cell.getParentRow();
          Table table = row.getParentTable();
          String cellStatusInRow = cell.isFirstCell() && cell.isLastCell() ? "only" : cell.isFirstCell() ? "first" : cell.isLastCell() ? "last" : "";
          if (!"".equals(cellStatusInRow)) {
              cellStatusInRow = MessageFormat.format(", the {0} cell in this row", cellStatusInRow);
          }
  
          indentAndAppendLine(MessageFormat.format("[Cell start] Row {0}, Col {1}{2}", table.indexOf(row) + 1, row.indexOf(cell) + 1, cellStatusInRow));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Cell node have been visited.
      /// </summary>
      public int visitCellEnd(final Cell cell) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Cell end]");
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Append a line to the StringBuilder, and indent it depending on how deep the visitor is
      /// into the current table's tree of child nodes.
      /// </summary>
      /// <param name="text"></param>
      private void indentAndAppendLine(final String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mVisitedTables.append("|  ");
          }
  
          mVisitedTables.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideTable;
      private int mDocTraversalDepth;
      private /*final*/ StringBuilder mVisitedTables;
  }

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

• hasChildNodes

  public boolean hasChildNodes()
  

  Returns true if this node has any child nodes.

  Example:

  Shows how to combine the rows from two tables into one.

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

• isComposite

  public boolean isComposite()
  

  Returns true as this node can have child nodes.

  Example:

  Shows how to efficiently visit all direct and indirect children of a composite node.

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

• isFirstRow

  public boolean isFirstRow()
  

  True if this is the first row in a table; false otherwise.

  Example:

  Shows how to print the node structure of every table in a document.

  public void tableToText() throws Exception {
      Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
      TableStructurePrinter visitor = new TableStructurePrinter();
  
      // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
      // and then traverses all of the node's children in a depth-first manner.
      // The visitor can read and modify each visited node.
      doc.accept(visitor);
  
      System.out.println(visitor.getText());
  }
  
  /// <summary>
  /// Traverses a node's non-binary tree of child nodes.
  /// Creates a map in the form of a string of all encountered Table nodes and their children.
  /// </summary>
  public static class TableStructurePrinter extends DocumentVisitor {
      public TableStructurePrinter() {
          mVisitedTables = new StringBuilder();
          mVisitorIsInsideTable = false;
      }
  
      public String getText() {
          return mVisitedTables.toString();
      }
  
      /// <summary>
      /// Called when a Run node is encountered in the document.
      /// Runs that are not within tables are not recorded.
      /// </summary>
      public /*override*/ /*VisitorAction*/int visitRun(Run run) {
          if (mVisitorIsInsideTable) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Table is encountered in the document.
      /// </summary>
      public int visitTableStart(final Table table) {
          int rows = 0;
          int columns = 0;
  
          if (table.getRows().getCount() > 0) {
              rows = table.getRows().getCount();
              columns = table.getFirstRow().getCount();
          }
  
          indentAndAppendLine("[Table start] Size: " + rows + "x" + columns);
          mDocTraversalDepth++;
          mVisitorIsInsideTable = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Table node have been visited.
      /// </summary>
      public int visitTableEnd(final Table table) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Table end]");
          mVisitorIsInsideTable = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Row node is encountered in the document.
      /// </summary>
      public int visitRowStart(final Row row) {
          String rowContents = row.getText().replaceAll("\\u0007", ", ").replaceAll(", , ", "");
          int rowWidth = row.indexOf(row.getLastCell()) + 1;
          int rowIndex = row.getParentTable().indexOf(row);
          String rowStatusInTable = row.isFirstRow() && row.isLastRow() ? "only" : row.isFirstRow() ? "first" : row.isLastRow() ? "last" : "";
          if (!"".equals(rowStatusInTable)) {
              rowStatusInTable = MessageFormat.format(", the {0} row in this table,", rowStatusInTable);
          }
  
          indentAndAppendLine(MessageFormat.format("[Row start] Row #{0}{1} width {2}, \"{3}\"", ++rowIndex, rowStatusInTable, rowWidth, rowContents));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Row node have been visited.
      /// </summary>
      public int visitRowEnd(final Row row) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Row end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Cell node is encountered in the document.
      /// </summary>
      public int visitCellStart(final Cell cell) {
          Row row = cell.getParentRow();
          Table table = row.getParentTable();
          String cellStatusInRow = cell.isFirstCell() && cell.isLastCell() ? "only" : cell.isFirstCell() ? "first" : cell.isLastCell() ? "last" : "";
          if (!"".equals(cellStatusInRow)) {
              cellStatusInRow = MessageFormat.format(", the {0} cell in this row", cellStatusInRow);
          }
  
          indentAndAppendLine(MessageFormat.format("[Cell start] Row {0}, Col {1}{2}", table.indexOf(row) + 1, row.indexOf(cell) + 1, cellStatusInRow));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Cell node have been visited.
      /// </summary>
      public int visitCellEnd(final Cell cell) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Cell end]");
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Append a line to the StringBuilder, and indent it depending on how deep the visitor is
      /// into the current table's tree of child nodes.
      /// </summary>
      /// <param name="text"></param>
      private void indentAndAppendLine(final String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mVisitedTables.append("|  ");
          }
  
          mVisitedTables.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideTable;
      private int mDocTraversalDepth;
      private /*final*/ StringBuilder mVisitedTables;
  }

• isLastRow

  public boolean isLastRow()
  

  True if this is the last row in a table; false otherwise.

  Example:

  Shows how to set a table to stay together on the same page.

  Document doc = new Document(getMyDir() + "Table spanning two pages.docx");
  Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
  
  // Enabling KeepWithNext for every paragraph in the table except for the last ones in the last row
  // will prevent the table from being split across pages 
  for (Cell cell : (Iterable<Cell>) table.getChildNodes(NodeType.CELL, true))
      for (Paragraph para : cell.getParagraphs()) {
          Assert.assertTrue(para.isInCell());
  
          if (!(cell.getParentRow().isLastRow() && para.isEndOfCell()))
              para.getParagraphFormat().setKeepWithNext(true);
      }
  
  doc.save(getArtifactsDir() + "Table.KeepTableTogether.docx");

• getLastCell

  public Cell getLastCell()
  

  Returns the last Cell in the row.

  Example:

  Shows how to print the node structure of every table in a document.

  public void tableToText() throws Exception {
      Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
      TableStructurePrinter visitor = new TableStructurePrinter();
  
      // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
      // and then traverses all of the node's children in a depth-first manner.
      // The visitor can read and modify each visited node.
      doc.accept(visitor);
  
      System.out.println(visitor.getText());
  }
  
  /// <summary>
  /// Traverses a node's non-binary tree of child nodes.
  /// Creates a map in the form of a string of all encountered Table nodes and their children.
  /// </summary>
  public static class TableStructurePrinter extends DocumentVisitor {
      public TableStructurePrinter() {
          mVisitedTables = new StringBuilder();
          mVisitorIsInsideTable = false;
      }
  
      public String getText() {
          return mVisitedTables.toString();
      }
  
      /// <summary>
      /// Called when a Run node is encountered in the document.
      /// Runs that are not within tables are not recorded.
      /// </summary>
      public /*override*/ /*VisitorAction*/int visitRun(Run run) {
          if (mVisitorIsInsideTable) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Table is encountered in the document.
      /// </summary>
      public int visitTableStart(final Table table) {
          int rows = 0;
          int columns = 0;
  
          if (table.getRows().getCount() > 0) {
              rows = table.getRows().getCount();
              columns = table.getFirstRow().getCount();
          }
  
          indentAndAppendLine("[Table start] Size: " + rows + "x" + columns);
          mDocTraversalDepth++;
          mVisitorIsInsideTable = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Table node have been visited.
      /// </summary>
      public int visitTableEnd(final Table table) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Table end]");
          mVisitorIsInsideTable = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Row node is encountered in the document.
      /// </summary>
      public int visitRowStart(final Row row) {
          String rowContents = row.getText().replaceAll("\\u0007", ", ").replaceAll(", , ", "");
          int rowWidth = row.indexOf(row.getLastCell()) + 1;
          int rowIndex = row.getParentTable().indexOf(row);
          String rowStatusInTable = row.isFirstRow() && row.isLastRow() ? "only" : row.isFirstRow() ? "first" : row.isLastRow() ? "last" : "";
          if (!"".equals(rowStatusInTable)) {
              rowStatusInTable = MessageFormat.format(", the {0} row in this table,", rowStatusInTable);
          }
  
          indentAndAppendLine(MessageFormat.format("[Row start] Row #{0}{1} width {2}, \"{3}\"", ++rowIndex, rowStatusInTable, rowWidth, rowContents));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Row node have been visited.
      /// </summary>
      public int visitRowEnd(final Row row) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Row end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Cell node is encountered in the document.
      /// </summary>
      public int visitCellStart(final Cell cell) {
          Row row = cell.getParentRow();
          Table table = row.getParentTable();
          String cellStatusInRow = cell.isFirstCell() && cell.isLastCell() ? "only" : cell.isFirstCell() ? "first" : cell.isLastCell() ? "last" : "";
          if (!"".equals(cellStatusInRow)) {
              cellStatusInRow = MessageFormat.format(", the {0} cell in this row", cellStatusInRow);
          }
  
          indentAndAppendLine(MessageFormat.format("[Cell start] Row {0}, Col {1}{2}", table.indexOf(row) + 1, row.indexOf(cell) + 1, cellStatusInRow));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Cell node have been visited.
      /// </summary>
      public int visitCellEnd(final Cell cell) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Cell end]");
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Append a line to the StringBuilder, and indent it depending on how deep the visitor is
      /// into the current table's tree of child nodes.
      /// </summary>
      /// <param name="text"></param>
      private void indentAndAppendLine(final String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mVisitedTables.append("|  ");
          }
  
          mVisitedTables.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideTable;
      private int mDocTraversalDepth;
      private /*final*/ StringBuilder mVisitedTables;
  }

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

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

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

• getParentTable

  public Table getParentTable()
  

  Returns the immediate parent table of the row.

  Equivalent to (Table)FirstNonMarkupParentNode.

  Example:

  Shows how to print the node structure of every table in a document.

  public void tableToText() throws Exception {
      Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
      TableStructurePrinter visitor = new TableStructurePrinter();
  
      // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
      // and then traverses all of the node's children in a depth-first manner.
      // The visitor can read and modify each visited node.
      doc.accept(visitor);
  
      System.out.println(visitor.getText());
  }
  
  /// <summary>
  /// Traverses a node's non-binary tree of child nodes.
  /// Creates a map in the form of a string of all encountered Table nodes and their children.
  /// </summary>
  public static class TableStructurePrinter extends DocumentVisitor {
      public TableStructurePrinter() {
          mVisitedTables = new StringBuilder();
          mVisitorIsInsideTable = false;
      }
  
      public String getText() {
          return mVisitedTables.toString();
      }
  
      /// <summary>
      /// Called when a Run node is encountered in the document.
      /// Runs that are not within tables are not recorded.
      /// </summary>
      public /*override*/ /*VisitorAction*/int visitRun(Run run) {
          if (mVisitorIsInsideTable) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Table is encountered in the document.
      /// </summary>
      public int visitTableStart(final Table table) {
          int rows = 0;
          int columns = 0;
  
          if (table.getRows().getCount() > 0) {
              rows = table.getRows().getCount();
              columns = table.getFirstRow().getCount();
          }
  
          indentAndAppendLine("[Table start] Size: " + rows + "x" + columns);
          mDocTraversalDepth++;
          mVisitorIsInsideTable = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Table node have been visited.
      /// </summary>
      public int visitTableEnd(final Table table) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Table end]");
          mVisitorIsInsideTable = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Row node is encountered in the document.
      /// </summary>
      public int visitRowStart(final Row row) {
          String rowContents = row.getText().replaceAll("\\u0007", ", ").replaceAll(", , ", "");
          int rowWidth = row.indexOf(row.getLastCell()) + 1;
          int rowIndex = row.getParentTable().indexOf(row);
          String rowStatusInTable = row.isFirstRow() && row.isLastRow() ? "only" : row.isFirstRow() ? "first" : row.isLastRow() ? "last" : "";
          if (!"".equals(rowStatusInTable)) {
              rowStatusInTable = MessageFormat.format(", the {0} row in this table,", rowStatusInTable);
          }
  
          indentAndAppendLine(MessageFormat.format("[Row start] Row #{0}{1} width {2}, \"{3}\"", ++rowIndex, rowStatusInTable, rowWidth, rowContents));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Row node have been visited.
      /// </summary>
      public int visitRowEnd(final Row row) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Row end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Cell node is encountered in the document.
      /// </summary>
      public int visitCellStart(final Cell cell) {
          Row row = cell.getParentRow();
          Table table = row.getParentTable();
          String cellStatusInRow = cell.isFirstCell() && cell.isLastCell() ? "only" : cell.isFirstCell() ? "first" : cell.isLastCell() ? "last" : "";
          if (!"".equals(cellStatusInRow)) {
              cellStatusInRow = MessageFormat.format(", the {0} cell in this row", cellStatusInRow);
          }
  
          indentAndAppendLine(MessageFormat.format("[Cell start] Row {0}, Col {1}{2}", table.indexOf(row) + 1, row.indexOf(cell) + 1, cellStatusInRow));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Cell node have been visited.
      /// </summary>
      public int visitCellEnd(final Cell cell) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Cell end]");
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Append a line to the StringBuilder, and indent it depending on how deep the visitor is
      /// into the current table's tree of child nodes.
      /// </summary>
      /// <param name="text"></param>
      private void indentAndAppendLine(final String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mVisitedTables.append("|  ");
          }
  
          mVisitedTables.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideTable;
      private int mDocTraversalDepth;
      private /*final*/ StringBuilder mVisitedTables;
  }

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

• getRowFormat

  public RowFormat getRowFormat()
  

  Provides access to the formatting properties of the row.

  Example:

  Shows how to modify formatting of a table row.

  Document doc = new Document(getMyDir() + "Tables.docx");
  Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
  
  // Retrieve the first row in the table
  Row firstRow = table.getFirstRow();
  
  // Modify some row level properties
  firstRow.getRowFormat().getBorders().setLineStyle(LineStyle.NONE);
  firstRow.getRowFormat().setHeightRule(HeightRule.AUTO);
  firstRow.getRowFormat().setAllowBreakAcrossPages(true);
  
  doc.save(getArtifactsDir() + "Table.RowFormat.docx");

  Example:

  Shows how to modify the format of rows and cells.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("City");
  builder.insertCell();
  builder.write("Country");
  builder.endRow();
  builder.insertCell();
  builder.write("London");
  builder.insertCell();
  builder.write("U.K.");
  builder.endTable();
  
  // The appearance of rows and individual cells can be edited using the respective formatting objects
  RowFormat rowFormat = table.getFirstRow().getRowFormat();
  rowFormat.setHeight(25.0);
  rowFormat.getBorders().getByBorderType(BorderType.BOTTOM).setColor(Color.RED);
  
  CellFormat cellFormat = table.getLastRow().getFirstCell().getCellFormat();
  cellFormat.setWidth(100.0);
  cellFormat.getShading().setBackgroundPatternColor(Color.ORANGE);
  
  doc.save(getArtifactsDir() + "Table.RowCellFormat.docx");

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.VisitRowStart, then calls Accept for all child nodes of the section and calls DocumentVisitor.VisitRowEnd 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:

  Shows how to print the node structure of every table in a document.

  public void tableToText() throws Exception {
      Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
      TableStructurePrinter visitor = new TableStructurePrinter();
  
      // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
      // and then traverses all of the node's children in a depth-first manner.
      // The visitor can read and modify each visited node.
      doc.accept(visitor);
  
      System.out.println(visitor.getText());
  }
  
  /// <summary>
  /// Traverses a node's non-binary tree of child nodes.
  /// Creates a map in the form of a string of all encountered Table nodes and their children.
  /// </summary>
  public static class TableStructurePrinter extends DocumentVisitor {
      public TableStructurePrinter() {
          mVisitedTables = new StringBuilder();
          mVisitorIsInsideTable = false;
      }
  
      public String getText() {
          return mVisitedTables.toString();
      }
  
      /// <summary>
      /// Called when a Run node is encountered in the document.
      /// Runs that are not within tables are not recorded.
      /// </summary>
      public /*override*/ /*VisitorAction*/int visitRun(Run run) {
          if (mVisitorIsInsideTable) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Table is encountered in the document.
      /// </summary>
      public int visitTableStart(final Table table) {
          int rows = 0;
          int columns = 0;
  
          if (table.getRows().getCount() > 0) {
              rows = table.getRows().getCount();
              columns = table.getFirstRow().getCount();
          }
  
          indentAndAppendLine("[Table start] Size: " + rows + "x" + columns);
          mDocTraversalDepth++;
          mVisitorIsInsideTable = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Table node have been visited.
      /// </summary>
      public int visitTableEnd(final Table table) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Table end]");
          mVisitorIsInsideTable = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Row node is encountered in the document.
      /// </summary>
      public int visitRowStart(final Row row) {
          String rowContents = row.getText().replaceAll("\\u0007", ", ").replaceAll(", , ", "");
          int rowWidth = row.indexOf(row.getLastCell()) + 1;
          int rowIndex = row.getParentTable().indexOf(row);
          String rowStatusInTable = row.isFirstRow() && row.isLastRow() ? "only" : row.isFirstRow() ? "first" : row.isLastRow() ? "last" : "";
          if (!"".equals(rowStatusInTable)) {
              rowStatusInTable = MessageFormat.format(", the {0} row in this table,", rowStatusInTable);
          }
  
          indentAndAppendLine(MessageFormat.format("[Row start] Row #{0}{1} width {2}, \"{3}\"", ++rowIndex, rowStatusInTable, rowWidth, rowContents));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Row node have been visited.
      /// </summary>
      public int visitRowEnd(final Row row) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Row end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Cell node is encountered in the document.
      /// </summary>
      public int visitCellStart(final Cell cell) {
          Row row = cell.getParentRow();
          Table table = row.getParentTable();
          String cellStatusInRow = cell.isFirstCell() && cell.isLastCell() ? "only" : cell.isFirstCell() ? "first" : cell.isLastCell() ? "last" : "";
          if (!"".equals(cellStatusInRow)) {
              cellStatusInRow = MessageFormat.format(", the {0} cell in this row", cellStatusInRow);
          }
  
          indentAndAppendLine(MessageFormat.format("[Cell start] Row {0}, Col {1}{2}", table.indexOf(row) + 1, row.indexOf(cell) + 1, cellStatusInRow));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Cell node have been visited.
      /// </summary>
      public int visitCellEnd(final Cell cell) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Cell end]");
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Append a line to the StringBuilder, and indent it depending on how deep the visitor is
      /// into the current table's tree of child nodes.
      /// </summary>
      /// <param name="text"></param>
      private void indentAndAppendLine(final String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mVisitedTables.append("|  ");
          }
  
          mVisitedTables.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideTable;
      private int mDocTraversalDepth;
      private /*final*/ StringBuilder mVisitedTables;
  }

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

• 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 Row has no cells, creates and appends one Cell.

  Example:

  Shows how to ensure a row 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);
  
  // Create a new row and add it to the table
  Row row = new Row(doc);
  table.appendChild(row);
  
  // Currently, the row does not contain any cells or nodes that can have content added to them
  Assert.assertEquals(0, row.getChildNodes(NodeType.ANY, true).getCount());
  
  // Ensure the row has at least one cell with one paragraph that we can edit
  row.ensureMinimum();
  row.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 to the local file system as individual files.

  Document doc = new Document(getMyDir() + "Images.docx");
  
  // Get the collection of shapes from the document,
  // and save the image data of every shape with an image as a file to the local file system.
  NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
  
  int imageIndex = 0;
  for (Shape shape : (Iterable<Shape>) shapes) {
      if (shape.hasImage()) {
          // The image data of shapes may contain images of many possible image formats. 
          // We can determine a file extension for each image automatically, based on its format.
          String imageFileName = MessageFormat.format("File.ExtractImages.{0}{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
          shape.getImageData().save(getArtifactsDir() + imageFileName);
          imageIndex++;
      }
  }

• getText

  public java.lang.String getText()

  Gets the text of all cells in this row including the end of row character.

  Returns concatenated text of all child nodes with the end of row character ControlChar.CELL appended at the end.

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

  Example:

  Shows how to print the node structure of every table in a document.

  public void tableToText() throws Exception {
      Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
      TableStructurePrinter visitor = new TableStructurePrinter();
  
      // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
      // and then traverses all of the node's children in a depth-first manner.
      // The visitor can read and modify each visited node.
      doc.accept(visitor);
  
      System.out.println(visitor.getText());
  }
  
  /// <summary>
  /// Traverses a node's non-binary tree of child nodes.
  /// Creates a map in the form of a string of all encountered Table nodes and their children.
  /// </summary>
  public static class TableStructurePrinter extends DocumentVisitor {
      public TableStructurePrinter() {
          mVisitedTables = new StringBuilder();
          mVisitorIsInsideTable = false;
      }
  
      public String getText() {
          return mVisitedTables.toString();
      }
  
      /// <summary>
      /// Called when a Run node is encountered in the document.
      /// Runs that are not within tables are not recorded.
      /// </summary>
      public /*override*/ /*VisitorAction*/int visitRun(Run run) {
          if (mVisitorIsInsideTable) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Table is encountered in the document.
      /// </summary>
      public int visitTableStart(final Table table) {
          int rows = 0;
          int columns = 0;
  
          if (table.getRows().getCount() > 0) {
              rows = table.getRows().getCount();
              columns = table.getFirstRow().getCount();
          }
  
          indentAndAppendLine("[Table start] Size: " + rows + "x" + columns);
          mDocTraversalDepth++;
          mVisitorIsInsideTable = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Table node have been visited.
      /// </summary>
      public int visitTableEnd(final Table table) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Table end]");
          mVisitorIsInsideTable = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Row node is encountered in the document.
      /// </summary>
      public int visitRowStart(final Row row) {
          String rowContents = row.getText().replaceAll("\\u0007", ", ").replaceAll(", , ", "");
          int rowWidth = row.indexOf(row.getLastCell()) + 1;
          int rowIndex = row.getParentTable().indexOf(row);
          String rowStatusInTable = row.isFirstRow() && row.isLastRow() ? "only" : row.isFirstRow() ? "first" : row.isLastRow() ? "last" : "";
          if (!"".equals(rowStatusInTable)) {
              rowStatusInTable = MessageFormat.format(", the {0} row in this table,", rowStatusInTable);
          }
  
          indentAndAppendLine(MessageFormat.format("[Row start] Row #{0}{1} width {2}, \"{3}\"", ++rowIndex, rowStatusInTable, rowWidth, rowContents));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Row node have been visited.
      /// </summary>
      public int visitRowEnd(final Row row) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Row end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Cell node is encountered in the document.
      /// </summary>
      public int visitCellStart(final Cell cell) {
          Row row = cell.getParentRow();
          Table table = row.getParentTable();
          String cellStatusInRow = cell.isFirstCell() && cell.isLastCell() ? "only" : cell.isFirstCell() ? "first" : cell.isLastCell() ? "last" : "";
          if (!"".equals(cellStatusInRow)) {
              cellStatusInRow = MessageFormat.format(", the {0} cell in this row", cellStatusInRow);
          }
  
          indentAndAppendLine(MessageFormat.format("[Cell start] Row {0}, Col {1}{2}", table.indexOf(row) + 1, row.indexOf(cell) + 1, cellStatusInRow));
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a Cell node have been visited.
      /// </summary>
      public int visitCellEnd(final Cell cell) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Cell end]");
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Append a line to the StringBuilder, and indent it depending on how deep the visitor is
      /// into the current table's tree of child nodes.
      /// </summary>
      /// <param name="text"></param>
      private void indentAndAppendLine(final String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mVisitedTables.append("|  ");
          }
  
          mVisitedTables.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideTable;
      private int mDocTraversalDepth;
      private /*final*/ StringBuilder mVisitedTables;
  }

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

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