com.aspose.words

Constructor Detail

• Body

  public Body(DocumentBase doc)

  Initializes a new instance of the Body class.

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

  To append Body to a Section use Section.InsertAfter or Section.InsertBefore.

  Parameters:

  doc - The owner document.

  Example:

  Creates a simple document from scratch using the Aspose.Words object model.

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

Property Getters/Setters Detail

• getChildNodes

  public NodeCollection getChildNodes()
  

  Gets all immediate child nodes of this node.

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

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

  Example:

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

  NodeCollection children = paragraph.getChildNodes();
  for (Node child : (Iterable<Node>) children) {
      // Paragraph may contain children of various types such as runs, shapes and so on.
      if (child.getNodeType() == NodeType.RUN) {
          // Say we found the node that we want, do something useful.
          Run run = (Run) child;
          System.out.println(run.getText());
      }
  }

• getCount

  public int getCount()
  

  Gets the number of immediate children of this node.

  Example:

  Shows how to add, update and delete child nodes from within a CompositeNode.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1);
  
  // 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(paragraph.getText(), "Initial text. " + (char) 12);
  
  // 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(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4);
  
  // 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(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);

• getDocument

  public DocumentBase getDocument()
  

  Gets the document to which this node belongs.

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

  Example:

  Shows that when you create any node, it requires a document that will own the node.

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

• getFirstChild

  public Node getFirstChild()
  

  Gets the first child of the node.

  If there is no first child node, a null is returned.

  Example:

  Shows how to enumerate immediate child nodes of a composite node using NextSibling. In this example we enumerate all paragraphs of a section body.

  // Get the section that we want to work on.
  Section section = doc.getSections().get(0);
  Body body = section.getBody();
  
  // Loop starting from the first child until we reach null.
  for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling()) {
      // Output the types of the nodes that we come across.
      System.out.println(Node.nodeTypeToString(node.getNodeType()));
  }

  Example:

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

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

• getFirstParagraph

  public Paragraph getFirstParagraph()
  

  Gets the first paragraph in the story.

  Example:

  Shows how to add a formatted run of text to a document using the object model.

  // Create an empty document. It contains one empty paragraph.
  Document doc = new Document();
  
  // Create a new run of text.
  Run run = new Run(doc, "Hello");
  
  // Specify character formatting for the run of text.
  Font f = run.getFont();
  f.setName("Courier New");
  f.setSize(36);
  f.setHighlightColor(Color.YELLOW);
  
  // Append the run of text to the end of the first paragraph
  // in the body of the first section of the document.
  doc.getFirstSection().getBody().getFirstParagraph().appendChild(run);

  Example:

  Creates a textbox with some text and different formatting options in a new document.

  // Create a blank document.
  Document doc = new Document();
  
  // Create a new shape of type TextBox
  Shape textBox = new Shape(doc, ShapeType.TEXT_BOX);
  
  // Set some settings of the textbox itself.
  // Set the wrap of the textbox to inline
  textBox.setWrapType(WrapType.NONE);
  // Set the horizontal and vertical alignment of the text inside the shape.
  textBox.setHorizontalAlignment(HorizontalAlignment.CENTER);
  textBox.setVerticalAlignment(VerticalAlignment.TOP);
  
  // Set the textbox height and width.
  textBox.setHeight(50);
  textBox.setWidth(200);
  
  // Set the textbox in front of other shapes with a lower ZOrder
  textBox.setZOrder(2);
  
  // Let's create a new paragraph for the textbox manually and align it in the center. Make sure we add the new nodes to the textbox as well.
  textBox.appendChild(new Paragraph(doc));
  Paragraph para = textBox.getFirstParagraph();
  para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
  
  // Add some text to the paragraph.
  Run run = new Run(doc);
  run.setText("Content in textbox");
  para.appendChild(run);
  
  // Append the textbox to the first paragraph in the body.
  doc.getFirstSection().getBody().getFirstParagraph().appendChild(textBox);
  
  // Save the output
  doc.save(getArtifactsDir() + "Shape.CreateTextBox.doc");

• hasChildNodes

  public boolean hasChildNodes()
  

  Returns true if this node has any child nodes.

  Example:

  Demonstrates how to use the InsertDocument method to insert a document into a merge field during mail merge.

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

• isComposite

  public boolean isComposite()
  

  Returns true as this node can have child nodes.

  Example:

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

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

• getLastChild

  public Node getLastChild()
  

  Gets the last child of the node.

  If there is no last child node, a null is returned.

  Example:

  Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.

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

• getLastParagraph

  public Paragraph getLastParagraph()
  

  Gets the last paragraph in the story.

  Example:

  Shows how to move a cursor position to a specified node.

  Document doc = new Document(getMyDir() + "DocumentBuilder.doc");
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.moveTo(doc.getFirstSection().getBody().getLastParagraph());

• getNextSibling

  public Node getNextSibling()
  

  Gets the node immediately following this node.

  If there is no next node, a null is returned.

  Example:

  Shows how to enumerate immediate child nodes of a composite node using NextSibling. In this example we enumerate all paragraphs of a section body.

  // Get the section that we want to work on.
  Section section = doc.getSections().get(0);
  Body body = section.getBody();
  
  // Loop starting from the first child until we reach null.
  for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling()) {
      // Output the types of the nodes that we come across.
      System.out.println(Node.nodeTypeToString(node.getNodeType()));
  }

  Example:

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

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

• getNodeType

  public int getNodeType()
  

  Returns NodeType.Body. The value of the property is NodeType integer constant.

  Example:

  Shows how you can enumerate through children of a composite node and detect types of the children nodes.

  // Open a document.
  Document doc = new Document(getMyDir() + "Section.BodyNodeType.doc");
  
  // Get the first section in the document.
  Section section = doc.getFirstSection();
  
  // A Section is a composite node and therefore can contain child nodes.
  // Section can contain only Body and HeaderFooter nodes.
  for (Node node : section) {
      // Every node has the NodeType property.
      switch (node.getNodeType()) {
          case NodeType.BODY:
              // If the node type is Body, we can cast the node to the Body class.
              Body body = (Body) node;
  
              // Write the content of the main story of the section to the console.
              System.out.println("*** Body ***");
              System.out.println(body.getText());
              break;
  
          case NodeType.HEADER_FOOTER:
              // If the node type is HeaderFooter, we can cast the node to the HeaderFooter class.
              HeaderFooter headerFooter = (HeaderFooter) node;
  
              // Write the content of the header footer to the console.
              System.out.println("*** HeaderFooter ***");
              System.out.println(headerFooter.getHeaderFooterType());
              System.out.println(headerFooter.getText());
              break;
  
          default:
              // Other types of nodes never occur inside a Section node.
              throw new Exception("Unexpected node type in a section.");
      }
  }

• getParagraphs

  public ParagraphCollection getParagraphs()
  

  Gets a collection of paragraphs that are immediate children of the story.

• getParentNode

  public CompositeNode getParentNode()
  

  Gets the immediate parent of this node.

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

  Example:

  Shows how to access the parent node.

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

  Example:

  Shows that when you create any node, it requires a document that will own the node.

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

• getParentSection

  public Section getParentSection()
  

  Gets the parent section of this story.

  ParentSection is equivalent to (Section)ParentNode.

  Example:

  Shows how to store endnotes at the end of each section instead of the document and manipulate their positions.

  public void suppressEndnotes() throws Exception {
      // Create a new document and make it empty
      Document doc = new Document();
      doc.removeAllChildren();
  
      // Normally endnotes are all stored at the end of a document, but this option lets us store them at the end of each section
      doc.getEndnoteOptions().setPosition(EndnotePosition.END_OF_SECTION);
  
      // Create 3 new sections, each having a paragraph and an endnote at the end
      insertSection(doc, "Section 1", "Endnote 1, will stay in section 1");
      insertSection(doc, "Section 2", "Endnote 2, will be pushed down to section 3");
      insertSection(doc, "Section 3", "Endnote 3, will stay in section 3");
  
      // Each section contains its own page setup object
      // Setting this value will push this section's endnotes down to the next section
      PageSetup pageSetup = doc.getSections().get(1).getPageSetup();
      pageSetup.setSuppressEndnotes(true);
  
      doc.save(getArtifactsDir() + "PageSetup.SuppressEndnotes.docx");
  }
  
  /// <summary>
  /// Add a section to the end of a document, give it a body and a paragraph, then add text and an endnote to that paragraph
  /// </summary>
  private void insertSection(Document doc, String sectionBodyText, String endnoteText) {
      Section section = new Section(doc);
  
      doc.appendChild(section);
  
      Body body = new Body(doc);
      section.appendChild(body);
  
      Assert.assertEquals(body.getParentNode(), section);
  
      Paragraph para = new Paragraph(doc);
      body.appendChild(para);
  
      Assert.assertEquals(para.getParentNode(), body);
  
      DocumentBuilder builder = new DocumentBuilder(doc);
      builder.moveTo(para);
      builder.write(sectionBodyText);
      builder.insertFootnote(FootnoteType.ENDNOTE, endnoteText);
  }

• getPreviousSibling

  public Node getPreviousSibling()
  

  Gets the node immediately preceding this node.

  If there is no preceding node, a null is returned.

  Example:

  Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.

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

• getRange

  public Range getRange()
  

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

  Example:

  Shows how to delete all characters of a range.

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

• getStoryType

  public int getStoryType()
  

  Gets the type of this story. The value of the property is StoryType integer constant.

• getTables

  public TableCollection getTables()
  

  Gets a collection of tables that are immediate children of the story.

  Example:

  Demonstrates how to use typed properties to access nodes of the document tree.

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

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

  Traverse a document with a visitor that prints all structure nodes that it encounters.

  public void docStructureToText() throws Exception {
      // Open the document that has nodes we want to print the info of
      Document doc = new Document(getMyDir() + "DocumentVisitor.Destination.docx");
  
      // Create an object that inherits from the DocumentVisitor class
      DocStructurePrinter visitor = new DocStructurePrinter();
  
      // Accepting a visitor lets it start traversing the nodes in the document,
      // starting with the node that accepted it to then recursively visit every child
      doc.accept(visitor);
  
      // Once the visiting is complete, we can retrieve the result of the operation,
      // that in this example, has accumulated in the visitor
      System.out.println(visitor.getText());
  }
  
  /// <summary>
  /// This Visitor implementation prints information about sections, bodies, paragraphs and runs encountered in the document.
  /// </summary>
  public static class DocStructurePrinter extends DocumentVisitor {
      public DocStructurePrinter() {
          mBuilder = new StringBuilder();
      }
  
      /// <summary>
      /// Gets the plain text of the document that was accumulated by the visitor.
      /// </summary>
      public String getText() {
          return mBuilder.toString();
      }
  
      /// <summary>
      /// Called when a Document node is encountered.
      /// </summary>
      public int visitDocumentStart(final Document doc) {
          int childNodeCount = doc.getChildNodes(NodeType.ANY, true).getCount();
  
          // A Document node is at the root of every document, so if we let a document accept a visitor, this will be the first visitor action to be carried out
          indentAndAppendLine("[Document start] Child nodes: " + childNodeCount);
          mDocTraversalDepth++;
  
          // Let the visitor continue visiting other nodes
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Document is ended.
      /// </summary>
      public int visitDocumentEnd(final Document doc) {
          // If we let a document accept a visitor, this will be the last visitor action to be carried out
          mDocTraversalDepth--;
          indentAndAppendLine("[Document end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Section node is encountered in the document.
      /// </summary>
      public int visitSectionStart(final Section section) {
          // Get the index of our section within the document
          NodeCollection docSections = section.getDocument().getChildNodes(NodeType.SECTION, false);
          int sectionIndex = docSections.indexOf(section);
  
          indentAndAppendLine("[Section start] Section index: " + sectionIndex);
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Section node is ended.
      /// </summary>
      public int visitSectionEnd(final Section section) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Section end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Body node is encountered in the document.
      /// </summary>
      public int visitBodyStart(final Body body) {
          int paragraphCount = body.getParagraphs().getCount();
          indentAndAppendLine("[Body start] Paragraphs: " + paragraphCount);
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Body node is ended.
      /// </summary>
      public int visitBodyEnd(final Body body) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Body end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Paragraph node is encountered in the document.
      /// </summary>
      public int visitParagraphStart(final Paragraph paragraph) {
          indentAndAppendLine("[Paragraph start]");
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Paragraph node is ended.
      /// </summary>
      public int visitParagraphEnd(final Paragraph paragraph) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Paragraph end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Run node is encountered in the document.
      /// </summary>
      public int visitRun(final Run run) {
          indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a SubDocument node is encountered in the document.
      /// </summary>
      public int visitSubDocument(final SubDocument subDocument) {
          indentAndAppendLine("[SubDocument]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Append a line to the StringBuilder and indent it depending on how deep the visitor is into the document tree.
      /// </summary>
      /// <param name="text"></param>
      private void indentAndAppendLine(final String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mBuilder.append("|  ");
          }
  
          mBuilder.append(text + "\r\n");
      }
  
      private int mDocTraversalDepth;
      private StringBuilder mBuilder;
  }

• appendChild

  public Node appendChild(Node newChild)

  Adds the specified node to the end of the list of child nodes for this node.

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

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

  Parameters:

  newChild - The node to add.

  Returns:

  The node added.

  Example:

  Creates a simple document from scratch using the Aspose.Words object model.

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

• appendParagraph

  public Paragraph appendParagraph(java.lang.String text)

  A shortcut method that creates a Paragraph object with optional text and appends it to the end of this object.

  Parameters:

  text - The text for the paragraph. Can be null or empty string.

  Returns:

  The newly created and appended paragraph.

  Example:

  Creates a footer using the document object model and inserts it into a section.

  Document doc = new Document();
  
  HeaderFooter header = new HeaderFooter(doc, HeaderFooterType.HEADER_PRIMARY);
  doc.getFirstSection().getHeadersFooters().add(header);
  
  // Add a paragraph with text to the footer.
  Paragraph para = header.appendParagraph("My header");
  
  Assert.assertTrue(header.isHeader());
  Assert.assertTrue(para.isEndOfHeaderFooter());
  
  HeaderFooter footer = new HeaderFooter(doc, HeaderFooterType.FOOTER_PRIMARY);
  doc.getFirstSection().getHeadersFooters().add(footer);
  
  // Add a paragraph with text to the footer.
  para = footer.appendParagraph("My footer");
  
  Assert.assertFalse(footer.isHeader());
  Assert.assertTrue(para.isEndOfHeaderFooter());
  
  Assert.assertEquals(para.getParentStory(), footer);
  Assert.assertEquals(para.getParentSection(), footer.getParentSection());
  Assert.assertEquals(header.getParentSection(), footer.getParentSection());
  
  doc.save(getArtifactsDir() + "HeaderFooter.CreateFooter.doc");

• deepClone

  public Node deepClone(boolean isCloneChildren)

  Example:

  Shows how to clone composite nodes with and without their child nodes.

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

• deleteShapes

  public void deleteShapes()

  Deletes all shapes from the text of this story.

• ensureMinimum

  public void ensureMinimum()

  If the last child is not a paragraph, creates and appends one empty paragraph.

  Example:

  Clears main text from all sections from the document leaving the sections themselves.

  // Open a document.
  Document doc = new Document(getMyDir() + "Section.BodyEnsureMinimum.doc");
  
  // This shows what is in the document originally. The document has two sections.
  System.out.println(doc.getText());
  
  // Loop through all sections in the document.
  for (Section section : doc.getSections()) {
      // Each section has a Body node that contains main story (main text) of the section.
      Body body = section.getBody();
  
      // This clears all nodes from the body.
      body.removeAllChildren();
  
      // Technically speaking, for the main story of a section to be valid, it needs to have
      // at least one empty paragraph. That's what the EnsureMinimum method does.
      body.ensureMinimum();
  }
  
  // Check how the content of the document looks now.
  System.out.println(doc.getText());

• getAncestor

  public CompositeNode getAncestor(int ancestorType)

  Gets the first ancestor of the specified NodeType.

  Parameters:

  ancestorType - A NodeType value. The node type of the ancestor to retrieve.

  Returns:

  The ancestor of the specified type or null if no ancestor of this type was found.

  Example:

  Shows how to find out if a table contains another table or if the table itself is nested inside another table.

  public void calculateDepthOfNestedTables() throws Exception {
      Document doc = new Document(getMyDir() + "Table.NestedTables.doc");
      int tableIndex = 0;
  
      for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true)) {
          // First lets find if any cells in the table have tables themselves as children.
          int count = getChildTableCount(table);
          System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count));
  
          // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth.
          int tableDepth = getNestedDepthOfTable(table);
  
          if (tableDepth > 0) {
              System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth));
          } else {
              System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex));
          }
  
          tableIndex++;
      }
  }
  
  /**
   * Calculates what level a table is nested inside other tables.
   *
   * @returns An integer containing the level the table is nested at.
   * 0 = Table is not nested inside any other table
   * 1 = Table is nested within one parent table
   * 2 = Table is nested within two parent tables etc..
   */
  private static int getNestedDepthOfTable(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() + "Table.NestedTables.doc");
      int tableIndex = 0;
  
      for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true)) {
          // First lets find if any cells in the table have tables themselves as children.
          int count = getChildTableCount(table);
          System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count));
  
          // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth.
          int tableDepth = getNestedDepthOfTable(table);
  
          if (tableDepth > 0) {
              System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth));
          } else {
              System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex));
          }
  
          tableIndex++;
      }
  }
  
  /**
   * Calculates what level a table is nested inside other tables.
   *
   * @returns An integer containing the level the table is nested at.
   * 0 = Table is not nested inside any other table
   * 1 = Table is nested within one parent table
   * 2 = Table is nested within two parent tables etc..
   */
  private static int getNestedDepthOfTable(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 test if a node is inside a field by using an XPath expression.

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

  Example:

  Shows how to extract a specific child node from a CompositeNode by using the GetChild method and passing the NodeType and index.

  Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);

• getChildNodes

  public NodeCollection getChildNodes(int nodeType, boolean isDeep)

  Returns a live collection of child nodes that match the specified type.

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

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

  Parameters:

  nodeType - A NodeType value. Specifies the type of nodes to select.

  isDeep - True to select from all child nodes recursively. False to select only among immediate children.

  Returns:

  A live collection of child nodes of the specified type.

  Example:

  Shows how to extract images from a document and save them as files.

  public void extractImagesToFiles() throws Exception {
      Document doc = new Document(getMyDir() + "Image.SampleImages.doc");
  
      NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
      int imageIndex = 0;
      for (Shape shape : (Iterable<Shape>) shapes) {
          if (shape.hasImage()) {
              String imageFileName = MessageFormat.format("Image.ExportImages.{0}{1}", imageIndex,
                      FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
              shape.getImageData().save(getArtifactsDir() + imageFileName);
              imageIndex++;
          }
      }
  }

  Example:

  Demonstrates how to remove a specified TOC from a document.

  public void removeTOCFromDocument() throws Exception {
      // Open a document which contains a TOC.
      Document doc = new Document(getMyDir() + "Document.TableOfContents.doc");
  
      // Remove the first TOC from the document.
      Field tocField = doc.getRange().getFields().get(0);
      tocField.remove();
  
      // Save the output.
      doc.save(getArtifactsDir() + "Document.TableOfContentsRemoveTOC.doc");
  }

• getText

  public java.lang.String getText()

  Gets the text of this node and of all its children.

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

  Example:

  Shows the difference between calling the GetText and ToString methods on a node.

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

  Example:

  Finds and outputs all paragraphs in a document that are bulleted or numbered.

  NodeCollection paras = doc.getChildNodes(NodeType.PARAGRAPH, true);
  for (Paragraph para : (Iterable<Paragraph>) paras) {
      if (para.getListFormat().isListItem()) {
          System.out.println(java.text.MessageFormat.format("*** A paragraph belongs to list {0}", para.getListFormat().getList().getListId()));
          System.out.println(para.getText());
      }
  }

• indexOf

  public int indexOf(Node child)

  Returns the index of the specified child node in the child node array.

  Returns -1 if the node is not found in the child nodes.

  Example:

  Shows how to get the index of a given child node from its parent.

  Document doc = new Document(getMyDir() + "Rendering.doc");
  
  // Get the body of the first section in the document.
  Body body = doc.getFirstSection().getBody();
  // Retrieve the index of the last paragraph in the body.
  int index = body.getChildNodes().indexOf(body.getLastParagraph());

  Example:

  Retrieves the index of a cell in a row.

  int cellIndex = row.indexOf(cell);

  Example:

  Retrieves the index of a row in a table.

  int rowIndex = table.indexOf(row);

• 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 add, update and delete child nodes from within a CompositeNode.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1);
  
  // 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(paragraph.getText(), "Initial text. " + (char) 12);
  
  // 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(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4);
  
  // 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(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);

  Example:

  Shows how to replace all textboxes with images.

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

• insertBefore

  public Node insertBefore(Node newChild, Node refChild)

  Inserts the specified node immediately before the specified reference node.

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

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

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

  Parameters:

  newChild - The Node to insert.

  refChild - The Node that is the reference node. The newChild is placed before this node.

  Returns:

  The inserted node.

  Example:

  Shows how to add, update and delete child nodes from within a CompositeNode.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1);
  
  // 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(paragraph.getText(), "Initial text. " + (char) 12);
  
  // 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(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4);
  
  // 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(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);

• iterator

  public java.util.Iterator<Node> iterator()

  Provides support for the for each style iteration over the child nodes of this node.

  Example:

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

  NodeCollection children = paragraph.getChildNodes();
  for (Node child : (Iterable<Node>) children) {
      // Paragraph may contain children of various types such as runs, shapes and so on.
      if (child.getNodeType() == NodeType.RUN) {
          // Say we found the node that we want, do something useful.
          Run run = (Run) child;
          System.out.println(run.getText());
      }
  }

• nextPreOrder

  public Node nextPreOrder(Node rootNode)

  Gets next node according to the pre-order tree traversal algorithm.

  Parameters:

  rootNode - The top node (limit) of traversal.

  Returns:

  Next node in pre-order order. Null if reached the rootNode.

  Example:

  Shows how to delete all images from a document using pre-order tree traversal.

  Node curNode = doc;
  while (curNode != null) {
      Node nextNode = curNode.nextPreOrder(doc);
  
      if (curNode.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;
  }

• 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 within a CompositeNode.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1);
  
  // 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(paragraph.getText(), "Initial text. " + (char) 12);
  
  // 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(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4);
  
  // 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(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);

• 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.

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

• remove

  public void remove()

  Removes itself from the parent.

  Example:

  Shows how to remove all nodes of a specific type from a composite node. In this example we remove tables from a section body.

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

  Example:

  Shows how to delete all images from a document.

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

• removeAllChildren

  public void removeAllChildren()

  Removes all the child nodes of the current node.

  Example:

  Creates a simple document from scratch using the Aspose.Words object model.

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

• removeChild

  public Node removeChild(Node oldChild)

  Removes the specified child node.

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

  Parameters:

  oldChild - The node to remove.

  Returns:

  The removed node.

  Example:

  Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.

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

• removeSmartTags

  public void removeSmartTags()

  Removes all SmartTag descendant nodes of the current node.

  This method does not remove the content of the smart tags.

  Example:

  Removes all smart tags from descendant nodes of the composite node.

  Document doc = new Document(getMyDir() + "Document.doc");
  
  // Remove smart tags from the first paragraph in the document.
  doc.getFirstSection().getBody().getFirstParagraph().removeSmartTags();

  Example:

  Shows how to remove all smart tags from a document.

  Document doc = new Document(getMyDir() + "Document.doc");
  doc.removeSmartTags();

• selectNodes

  public NodeList selectNodes(java.lang.String xpath)

  Selects a list of nodes matching the XPath expression.

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

  Parameters:

  xpath - The XPath expression.

  Returns:

  A list of nodes matching the XPath query.

  Example:

  Shows how to select certain nodes by using an XPath expression.

  Document doc = new Document(getMyDir() + "Table.Document.doc");
  
  // This expression will extract all paragraph nodes which are descendants of any table node in the document.
  // This will return any paragraphs which are in a table.
  NodeList nodeList = doc.selectNodes("//Table//Paragraph");
  
  // 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");

  Example:

  Shows how to test if a node is inside a field by using an XPath expression.

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

• selectSingleNode

  public Node selectSingleNode(java.lang.String xpath)

  Selects the first Node that matches the XPath expression.

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

  Parameters:

  xpath - The XPath expression.

  Returns:

  The first Node that matches the XPath query or null if no matching node is found.

  Example:

  Shows how to select certain nodes by using an XPath expression.

  Document doc = new Document(getMyDir() + "Table.Document.doc");
  
  // This expression will extract all paragraph nodes which are descendants of any table node in the document.
  // This will return any paragraphs which are in a table.
  NodeList nodeList = doc.selectNodes("//Table//Paragraph");
  
  // 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");

• toString

  public java.lang.String toString(SaveOptions saveOptions)
                 throws java.lang.Exception

  Exports the content of the node into a string using the specified save options.

  Parameters:

  saveOptions - Specifies the options that control how the node is saved.

  Returns:

  The content of the node in the specified format.

  Example:

  Exports the content of a node to string in HTML format using custom specified options.

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

• toString

  public java.lang.String toString(int saveFormat)
                 throws java.lang.Exception

  Exports the content of the node into a string in the specified format.

  Returns:

  The content of the node in the specified format.

  Parameters:

  saveFormat - A SaveFormat value.

  Example:

  Shows how to extract the label of each paragraph in a list as a value or a String.

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

  Example:

  Shows the difference between calling the GetText and ToString methods on a node.

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

  Example:

  Exports the content of a node to string in HTML format using default options.

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