com.aspose.words

Constructor Detail

• Section

  public Section(DocumentBase doc)

  Initializes a new instance of the Section class.

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

  To include Section into a document use Document.InsertAfter, Document.InsertBefore or Sections.Add and Section.Insert methods.

  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

• getBody

  public Body getBody()
  

  Returns the Body child node of the section.

  Body contains main text of the section.

  Returns null if the section does not have a Body node among its children.

  Example:

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

  // Open a document
  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.write("Section 1");
  builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
  builder.write("Section 2");
  
  // 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());

• 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() + "Document.docx");
  
      // 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);
          }
      }
  }

• hasChildNodes

  public boolean hasChildNodes()
  

  Returns true if this node has any child nodes.

• getHeadersFooters

  public HeaderFooterCollection getHeadersFooters()
  

  Provides access to the headers and footers nodes of the section.

  Example:

  Shows how to replace text in the document footer.

  // Open the template document, containing obsolete copyright information in the footer
  Document doc = new Document(getMyDir() + "Footer.docx");
  
  HeaderFooterCollection headersFooters = doc.getFirstSection().getHeadersFooters();
  HeaderFooter footer = headersFooters.getByHeaderFooterType(HeaderFooterType.FOOTER_PRIMARY);
  
  FindReplaceOptions options = new FindReplaceOptions();
  options.setMatchCase(false);
  options.setFindWholeWordsOnly(false);
  
  int currentYear = Calendar.getInstance().get(Calendar.YEAR);
  footer.getRange().replace("(C) 2006 Aspose Pty Ltd.", MessageFormat.format("Copyright (C) {0} by Aspose Pty Ltd.", currentYear), options);
  
  doc.save(getArtifactsDir() + "HeaderFooter.ReplaceText.doc");

  Example:

  Deletes all footers from all sections, but leaves headers intact.

  Document doc = new Document(getMyDir() + "Header and footer types.docx");
  
  for (Section section : doc.getSections()) {
      // Up to three different footers are possible in a section (for first, even and odd pages)
      // We check and delete all of them
      HeaderFooter footer;
  
      footer = section.getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_FIRST);
      if (footer != null) {
          footer.remove();
      }
  
      // Primary footer is the footer used for odd pages
      footer = section.getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_PRIMARY);
      if (footer != null) {
          footer.remove();
      }
  
      footer = section.getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_EVEN);
      if (footer != null) {
          footer.remove();
      }
  }
  
  doc.save(getArtifactsDir() + "HeaderFooter.RemoveFooters.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 {
      // Open a document
      Document doc = new Document(getMyDir() + "Document.docx");
  
      // 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:

  Shows how to 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);
  }

• 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() + "Document.docx");
  
      // 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.Section. The value of the property is NodeType integer constant.

  Example:

  Shows how to retrieve the NodeType enumeration of nodes.

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

• getPageSetup

  public PageSetup getPageSetup()
  

  Returns an object that represents page setup and section properties.

  Example:

  Creates a page border that looks like a wide blue band at the top of the first page only.

  Document doc = new Document();
  
  PageSetup ps = doc.getSections().get(0).getPageSetup();
  ps.setBorderAlwaysInFront(false);
  ps.setBorderDistanceFrom(PageBorderDistanceFrom.PAGE_EDGE);
  ps.setBorderAppliesTo(PageBorderAppliesTo.FIRST_PAGE);
  
  Border border = ps.getBorders().getByBorderType(BorderType.TOP);
  border.setLineStyle(LineStyle.SINGLE);
  border.setLineWidth(30);
  border.setColor(Color.BLUE);
  border.setDistanceFromText(0);
  
  doc.save(getArtifactsDir() + "PageSetup.PageBorderProperties.doc");

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

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

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

• getProtectedForForms/setProtectedForForms

  public boolean getProtectedForForms() / public void setProtectedForForms(boolean value)
  

  True if the section is protected for forms. When a section is protected for forms, users can select and modify text only in form fields in Microsoft Word.

  Example:

  Protects a section so only editing in form fields is possible.

  // Create a blank document
  Document doc = new Document();
  
  // Insert two sections with some text
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.writeln("Section 1. Unprotected.");
  builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
  builder.writeln("Section 2. Protected.");
  
  // Section protection only works when document protection is turned and only editing in form fields is allowed
  doc.protect(ProtectionType.ALLOW_ONLY_FORM_FIELDS);
  
  // By default, all sections are protected, but we can selectively turn protection off
  doc.getSections().get(0).setProtectedForForms(false);
  
  builder.getDocument().save(getArtifactsDir() + "Section.Protect.doc");

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

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

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

• appendContent

  public void appendContent(Section sourceSection)

  Inserts a copy of content of the source section at the end of this section.

  Only content of Body of the source section is copied, page setup, headers and footers are not copied.

  The nodes are automatically imported if the source section belongs to a different document.

  No new section is created in the destination document.

  Parameters:

  sourceSection - The section to copy content from.

  Example:

  Shows how to append content of an existing section. The number of sections in the document remains the same.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.write("Section 1");
  builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
  builder.write("Section 2");
  builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
  builder.write("Section 3");
  
  // This is the section that we will append and prepend to
  Section section = doc.getSections().get(2);
  
  // This copies content of the 1st section and inserts it at the beginning of the specified section
  Section sectionToPrepend = doc.getSections().get(0);
  section.prependContent(sectionToPrepend);
  
  // This copies content of the 2nd section and inserts it at the end of the specified section
  Section sectionToAppend = doc.getSections().get(1);
  section.appendContent(sectionToAppend);

• clearContent

  public void clearContent()

  Clears the section.

  The text of Body is cleared, only one empty paragraph is left that represents the section break.

  The text of all headers and footers is cleared, but HeaderFooter objects themselves are not removed.

  Example:

  Shows how to delete main content of a section.

  Document doc = new Document(getMyDir() + "Document.docx");
  Section section = doc.getSections().get(0);
  section.clearContent();

• clearHeadersFooters

  public void clearHeadersFooters()

  Clears the headers and footers of this section.

  The text of all headers and footers is cleared, but HeaderFooter objects themselves are not removed.

  This makes headers and footers of this section linked to headers and footers of the previous section.

  Example:

  Clears content of all headers and footers in a section.

  Document doc = new Document(getMyDir() + "Document.docx");
  Section section = doc.getSections().get(0);
  section.clearHeadersFooters();

• deepClone

  public Section deepClone()

  Creates a duplicate of this section.

  Example:

  Shows how to add/remove sections in a document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.write("Section 1");
  builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
  builder.write("Section 2");
  
  // This shows what is in the document originally. The document has two sections
  System.out.println(doc.getText());
  
  // Delete the first section from the document
  doc.getSections().removeAt(0);
  
  // Duplicate the last section and append the copy to the end of the document
  int lastSectionIdx = doc.getSections().getCount() - 1;
  Section newSection = doc.getSections().get(lastSectionIdx).deepClone();
  doc.getSections().add(newSection);
  
  // Check what the document contains after we changed it
  System.out.println(doc.getText());

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

• deleteHeaderFooterShapes

  public void deleteHeaderFooterShapes()

  Deletes all shapes (drawing objects) from the headers and footers of this section.

  Example:

  Removes all images and shapes from all headers footers in a section.

  Document doc = new Document(getMyDir() + "Document.docx");
  Section section = doc.getSections().get(0);
  section.deleteHeaderFooterShapes();

• ensureMinimum

  public void ensureMinimum()

  Ensures that the section has Body with one Paragraph.

  Example:

  Ensures that a section is valid.

  // Create a blank document
  Document doc = new Document();
  Section section = doc.getFirstSection();
  
  // Makes sure that the section contains a body with at least one paragraph
  section.ensureMinimum();

• getAncestor

  public CompositeNode getAncestor(int ancestorType)

  Gets the first ancestor of the specified NodeType.

  Parameters:

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

  Returns:

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

  Example:

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

  public void calculateDepthOfNestedTables() throws Exception {
      Document doc = new Document(getMyDir() + "Nested tables.docx");
      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() + "Nested tables.docx");
      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() + "Mail merge destination - Northwind employees.docx");
  
  // 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 get all comments with all replies.

  Document doc = new Document(getMyDir() + "Comments.docx");
  
  // Get all comment from the document
  NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
  // For all comments and replies we identify comment level and info about it
  for (Comment comment : (Iterable<Comment>) comments) {
      if (comment.getAncestor() == null) {
          System.out.println("\nThis is a top-level comment");
          System.out.println("Comment author: " + comment.getAuthor());
          System.out.println("Comment text: " + comment.getText());
  
          for (Comment commentReply : comment.getReplies())
          {
              System.out.println("\n\tThis is a comment reply");
              System.out.println("\tReply author: " + commentReply.getAuthor());
              System.out.println("\tReply text: " + commentReply.getText());
          }
      }
  }

  Example:

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

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

  Example:

  Demonstrates how to remove a specified TOC from a document.

  // Open a document which contains a TOC
  Document doc = new Document(getMyDir() + "Table of contents.docx");
  
  // Remove the first TOC from the document
  Field tocField = doc.getRange().getFields().get(0);
  tocField.remove();
  
  // Save the output
  doc.save(getArtifactsDir() + "Field.RemoveTocFromDocument.docx");

• 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 field into the document
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertField("MERGEFIELD Field");
  
  // GetText will retrieve all field codes and special characters
  Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());
  
  // ToString will give us the plaintext version of the document in the save format we put into the parameter
  Assert.assertEquals("«Field»\r\n", 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.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
  int index = 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 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() + "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.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.

  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;
  }
  
  Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  doc.save(getArtifactsDir() + "Image.DeleteAllImagesPreOrder.docx");

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

• prependContent

  public void prependContent(Section sourceSection)

  Inserts a copy of content of the source section at the beginning of this section.

  Only content of Body of the source section is copied, page setup, headers and footers are not copied.

  The nodes are automatically imported if the source section belongs to a different document.

  No new section is created in the destination document.

  Parameters:

  sourceSection - The section to copy content from.

  Example:

  Shows how to append content of an existing section. The number of sections in the document remains the same.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.write("Section 1");
  builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
  builder.write("Section 2");
  builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
  builder.write("Section 3");
  
  // This is the section that we will append and prepend to
  Section section = doc.getSections().get(2);
  
  // This copies content of the 1st section and inserts it at the beginning of the specified section
  Section sectionToPrepend = doc.getSections().get(0);
  section.prependContent(sectionToPrepend);
  
  // This copies content of the 2nd section and inserts it at the end of the specified section
  Section sectionToAppend = doc.getSections().get(1);
  section.appendContent(sectionToAppend);

• 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;
  }
  
  Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  doc.save(getArtifactsDir() + "Image.DeleteAllImagesPreOrder.docx");

• 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();
  }
  
  Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  doc.save(getArtifactsDir() + "Image.DeleteAllImages.docx");

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

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

  Shows how to 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.docx");
  
  // Remove smart tags from the first paragraph in the document
  doc.getFirstSection().getBody().getFirstParagraph().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() + "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");

  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() + "Mail merge destination - Northwind employees.docx");
  
  // 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() + "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");

• 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.docx");
  
  // 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() + "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("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:

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

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

  Example:

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

  Document doc = new Document();
  
  // Enter a field into the document
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertField("MERGEFIELD Field");
  
  // GetText will retrieve all field codes and special characters
  Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());
  
  // ToString will give us the plaintext version of the document in the save format we put into the parameter
  Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));