com.aspose.words

Constructor Detail

• Comment

  public Comment(DocumentBase doc)

  Initializes a new instance of the Comment class.

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

  To append Comment to the document use InsertAfter or InsertBefore on the paragraph where you want the comment inserted.

  After creating a comment, don't forget to set its Author, Initial and DateTime properties.

  Parameters:

  doc - The owner document.

  Example:

  Shows how to create comments with replies and get all interested info.

  public void createCommentsAndPrintAllInfo() throws Exception {
      Document doc = new Document();
      doc.removeAllChildren();
  
      Section sect = (Section) doc.appendChild(new Section(doc));
      Body body = (Body) sect.appendChild(new Body(doc));
  
      // Create a commented text with several comment replies
      for (int i = 0; i <= 10; i++) {
          Comment newComment = createComment(doc, "VDeryushev", "VD", new Date(), "My test comment " + i);
  
          Paragraph para = (Paragraph) body.appendChild(new Paragraph(doc));
          para.appendChild(new CommentRangeStart(doc, newComment.getId()));
          para.appendChild(new Run(doc, "Commented text " + i));
          para.appendChild(new CommentRangeEnd(doc, newComment.getId()));
          para.appendChild(newComment);
  
          for (int y = 0; y <= 2; y++) {
              newComment.addReply("John Doe", "JD", new Date(), "New reply " + y);
          }
      }
  
      // Look at information of our comments
      printAllCommentInfo(extractComments(doc));
  }
  
  /// <summary>
  /// Create a new comment.
  /// </summary>
  public static Comment createComment(Document doc, String author, String initials, Date dateTime, String text) {
      Comment newComment = new Comment(doc);
  
      newComment.setAuthor(author);
      newComment.setInitial(initials);
      newComment.setDateTime(dateTime);
      newComment.setText(text);
  
      return newComment;
  }
  
  /// <summary>
  /// Extract comments from the document without replies.
  /// </summary>
  public static ArrayList<Comment> extractComments(Document doc) {
      ArrayList<Comment> collectedComments = new ArrayList<>();
  
      NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
      for (Comment comment : (Iterable<Comment>) comments) {
          // All replies have ancestor, so we will add this check
          if (comment.getAncestor() == null) {
              collectedComments.add(comment);
          }
      }
  
      return collectedComments;
  }
  
  /// <summary>
  /// Use an iterator and a visitor to print info of every comment from within a document.
  /// </summary>
  private static void printAllCommentInfo(ArrayList<Comment> comments) throws Exception {
      // Create an object that inherits from the DocumentVisitor class
      CommentInfoPrinter commentVisitor = new CommentInfoPrinter();
  
      // Get the enumerator from the document's comment collection and iterate over the comments
      Iterator<Comment> enumerator = comments.iterator();
  
      while (enumerator.hasNext()) {
          Comment currentComment = enumerator.next();
  
          // Accept our DocumentVisitor it to print information about our comments
          if (currentComment != null) {
              // Get CommentRangeStart from our current comment and construct its information
              CommentRangeStart commentRangeStart = (CommentRangeStart) currentComment.getPreviousSibling().getPreviousSibling().getPreviousSibling();
              commentRangeStart.accept(commentVisitor);
  
              // Construct current comment information
              currentComment.accept(commentVisitor);
  
              // Get CommentRangeEnd from our current comment and construct its information
              CommentRangeEnd commentRangeEnd = (CommentRangeEnd) currentComment.getPreviousSibling();
              commentRangeEnd.accept(commentVisitor);
          }
      }
  
      // Output of all information received
      System.out.println(commentVisitor.getText());
  }
  
  /// <summary>
  /// This Visitor implementation prints information about and contents of comments and comment ranges encountered in the document.
  /// </summary>
  public static class CommentInfoPrinter extends DocumentVisitor {
      public CommentInfoPrinter() {
          mBuilder = new StringBuilder();
          mVisitorIsInsideComment = false;
      }
  
      /// <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 Run node is encountered in the document.
      /// </summary>
      public int visitRun(Run run) {
          if (mVisitorIsInsideComment) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeStart node is encountered in the document.
      /// </summary>
      public int visitCommentRangeStart(CommentRangeStart commentRangeStart) {
          indentAndAppendLine("[Comment range start] ID: " + commentRangeStart.getId());
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeEnd node is encountered in the document.
      /// </summary>
      public int visitCommentRangeEnd(CommentRangeEnd commentRangeEnd) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment range end] ID: " + commentRangeEnd.getId() + "\n");
          mVisitorIsInsideComment = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Comment node is encountered in the document.
      /// </summary>
      public int visitCommentStart(Comment comment) {
          indentAndAppendLine(MessageFormat.format("[Comment start] For comment range ID {0}, By {1} on {2}", comment.getId(),
                  comment.getAuthor(), comment.getDateTime()));
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Comment node is ended in the document.
      /// </summary>
      public int visitCommentEnd(Comment comment) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment end]");
          mVisitorIsInsideComment = false;
  
          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(String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mBuilder.append("|  ");
          }
  
          mBuilder.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideComment;
      private int mDocTraversalDepth;
      private StringBuilder mBuilder;
  }

• Comment

  public Comment(DocumentBase doc, java.lang.String author, java.lang.String initial, java.util.Date dateTime)

  Initializes a new instance of the Comment class.

  Parameters:

  doc - The owner document.

  author - The author name for the comment. Cannot be null.

  initial - The author initials for the comment. Cannot be null.

  dateTime - The date and time for the comment.

  Example:

  Shows how to add a comment to a paragraph in the document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.write("Some text is added.");
  
  Date currentDate  = new Date();
  
  Comment comment = new Comment(doc, "Amy Lee", "AL", currentDate);
  builder.getCurrentParagraph().appendChild(comment);
  comment.getParagraphs().add(new Paragraph(doc));
  comment.getFirstParagraph().getRuns().add(new Run(doc, "Comment text."));
  
  doc.save(getArtifactsDir() + "InlineStory.AddComment.docx");

Property Getters/Setters Detail

• getAncestor

  public Comment getAncestor()
  

  Returns the parent Comment object. Returns null for top-level comments.

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

• getAuthor/setAuthor

  public java.lang.String getAuthor() / public void setAuthor(java.lang.String value)
  

  Returns or sets the author name for a comment.

  Cannot be null.

  Default is empty string.

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

• getChildNodes

  public NodeCollection getChildNodes()
  

  Gets all immediate child nodes of this node.

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

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

  Example:

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

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

• getCount

  public int getCount()
  

  Gets the number of immediate children of this node.

  Example:

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

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

• getDateTime/setDateTime

  public java.util.Date getDateTime() / public void setDateTime(java.util.Date value)
  

  Gets the date and time that the comment was made.

  Default is 03.01.0001.

  Example:

  Shows how to create comments with replies and get all interested info.

  public void createCommentsAndPrintAllInfo() throws Exception {
      Document doc = new Document();
      doc.removeAllChildren();
  
      Section sect = (Section) doc.appendChild(new Section(doc));
      Body body = (Body) sect.appendChild(new Body(doc));
  
      // Create a commented text with several comment replies
      for (int i = 0; i <= 10; i++) {
          Comment newComment = createComment(doc, "VDeryushev", "VD", new Date(), "My test comment " + i);
  
          Paragraph para = (Paragraph) body.appendChild(new Paragraph(doc));
          para.appendChild(new CommentRangeStart(doc, newComment.getId()));
          para.appendChild(new Run(doc, "Commented text " + i));
          para.appendChild(new CommentRangeEnd(doc, newComment.getId()));
          para.appendChild(newComment);
  
          for (int y = 0; y <= 2; y++) {
              newComment.addReply("John Doe", "JD", new Date(), "New reply " + y);
          }
      }
  
      // Look at information of our comments
      printAllCommentInfo(extractComments(doc));
  }
  
  /// <summary>
  /// Create a new comment.
  /// </summary>
  public static Comment createComment(Document doc, String author, String initials, Date dateTime, String text) {
      Comment newComment = new Comment(doc);
  
      newComment.setAuthor(author);
      newComment.setInitial(initials);
      newComment.setDateTime(dateTime);
      newComment.setText(text);
  
      return newComment;
  }
  
  /// <summary>
  /// Extract comments from the document without replies.
  /// </summary>
  public static ArrayList<Comment> extractComments(Document doc) {
      ArrayList<Comment> collectedComments = new ArrayList<>();
  
      NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
      for (Comment comment : (Iterable<Comment>) comments) {
          // All replies have ancestor, so we will add this check
          if (comment.getAncestor() == null) {
              collectedComments.add(comment);
          }
      }
  
      return collectedComments;
  }
  
  /// <summary>
  /// Use an iterator and a visitor to print info of every comment from within a document.
  /// </summary>
  private static void printAllCommentInfo(ArrayList<Comment> comments) throws Exception {
      // Create an object that inherits from the DocumentVisitor class
      CommentInfoPrinter commentVisitor = new CommentInfoPrinter();
  
      // Get the enumerator from the document's comment collection and iterate over the comments
      Iterator<Comment> enumerator = comments.iterator();
  
      while (enumerator.hasNext()) {
          Comment currentComment = enumerator.next();
  
          // Accept our DocumentVisitor it to print information about our comments
          if (currentComment != null) {
              // Get CommentRangeStart from our current comment and construct its information
              CommentRangeStart commentRangeStart = (CommentRangeStart) currentComment.getPreviousSibling().getPreviousSibling().getPreviousSibling();
              commentRangeStart.accept(commentVisitor);
  
              // Construct current comment information
              currentComment.accept(commentVisitor);
  
              // Get CommentRangeEnd from our current comment and construct its information
              CommentRangeEnd commentRangeEnd = (CommentRangeEnd) currentComment.getPreviousSibling();
              commentRangeEnd.accept(commentVisitor);
          }
      }
  
      // Output of all information received
      System.out.println(commentVisitor.getText());
  }
  
  /// <summary>
  /// This Visitor implementation prints information about and contents of comments and comment ranges encountered in the document.
  /// </summary>
  public static class CommentInfoPrinter extends DocumentVisitor {
      public CommentInfoPrinter() {
          mBuilder = new StringBuilder();
          mVisitorIsInsideComment = false;
      }
  
      /// <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 Run node is encountered in the document.
      /// </summary>
      public int visitRun(Run run) {
          if (mVisitorIsInsideComment) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeStart node is encountered in the document.
      /// </summary>
      public int visitCommentRangeStart(CommentRangeStart commentRangeStart) {
          indentAndAppendLine("[Comment range start] ID: " + commentRangeStart.getId());
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeEnd node is encountered in the document.
      /// </summary>
      public int visitCommentRangeEnd(CommentRangeEnd commentRangeEnd) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment range end] ID: " + commentRangeEnd.getId() + "\n");
          mVisitorIsInsideComment = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Comment node is encountered in the document.
      /// </summary>
      public int visitCommentStart(Comment comment) {
          indentAndAppendLine(MessageFormat.format("[Comment start] For comment range ID {0}, By {1} on {2}", comment.getId(),
                  comment.getAuthor(), comment.getDateTime()));
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Comment node is ended in the document.
      /// </summary>
      public int visitCommentEnd(Comment comment) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment end]");
          mVisitorIsInsideComment = false;
  
          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(String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mBuilder.append("|  ");
          }
  
          mBuilder.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideComment;
      private int mDocTraversalDepth;
      private StringBuilder mBuilder;
  }

• getDocument

  public DocumentBase getDocument()
  

  Gets the document to which this node belongs.

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

  Example:

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

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

• getDone/setDone

  public boolean getDone() / public void setDone(boolean value)
  

  Gets or sets flag indicating that the comment has been marked done.

  Example:

  Shows how to mark comment as Done.

  Document doc = new Document(getMyDir() + "Comments.docx");
  
  NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
  Comment comment = (Comment) comments.get(0);
  CommentCollection repliesCollection = comment.getReplies();
  
  for (Comment childComment : repliesCollection) {
      if (!childComment.getDone()) {
          // Update comment reply Done mark
          childComment.setDone(true);
      }
  }

  Example:

  Shows how to create comments with replies and get all interested info.

  public void createCommentsAndPrintAllInfo() throws Exception {
      Document doc = new Document();
      doc.removeAllChildren();
  
      Section sect = (Section) doc.appendChild(new Section(doc));
      Body body = (Body) sect.appendChild(new Body(doc));
  
      // Create a commented text with several comment replies
      for (int i = 0; i <= 10; i++) {
          Comment newComment = createComment(doc, "VDeryushev", "VD", new Date(), "My test comment " + i);
  
          Paragraph para = (Paragraph) body.appendChild(new Paragraph(doc));
          para.appendChild(new CommentRangeStart(doc, newComment.getId()));
          para.appendChild(new Run(doc, "Commented text " + i));
          para.appendChild(new CommentRangeEnd(doc, newComment.getId()));
          para.appendChild(newComment);
  
          for (int y = 0; y <= 2; y++) {
              newComment.addReply("John Doe", "JD", new Date(), "New reply " + y);
          }
      }
  
      // Look at information of our comments
      printAllCommentInfo(extractComments(doc));
  }
  
  /// <summary>
  /// Create a new comment.
  /// </summary>
  public static Comment createComment(Document doc, String author, String initials, Date dateTime, String text) {
      Comment newComment = new Comment(doc);
  
      newComment.setAuthor(author);
      newComment.setInitial(initials);
      newComment.setDateTime(dateTime);
      newComment.setText(text);
  
      return newComment;
  }
  
  /// <summary>
  /// Extract comments from the document without replies.
  /// </summary>
  public static ArrayList<Comment> extractComments(Document doc) {
      ArrayList<Comment> collectedComments = new ArrayList<>();
  
      NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
      for (Comment comment : (Iterable<Comment>) comments) {
          // All replies have ancestor, so we will add this check
          if (comment.getAncestor() == null) {
              collectedComments.add(comment);
          }
      }
  
      return collectedComments;
  }
  
  /// <summary>
  /// Use an iterator and a visitor to print info of every comment from within a document.
  /// </summary>
  private static void printAllCommentInfo(ArrayList<Comment> comments) throws Exception {
      // Create an object that inherits from the DocumentVisitor class
      CommentInfoPrinter commentVisitor = new CommentInfoPrinter();
  
      // Get the enumerator from the document's comment collection and iterate over the comments
      Iterator<Comment> enumerator = comments.iterator();
  
      while (enumerator.hasNext()) {
          Comment currentComment = enumerator.next();
  
          // Accept our DocumentVisitor it to print information about our comments
          if (currentComment != null) {
              // Get CommentRangeStart from our current comment and construct its information
              CommentRangeStart commentRangeStart = (CommentRangeStart) currentComment.getPreviousSibling().getPreviousSibling().getPreviousSibling();
              commentRangeStart.accept(commentVisitor);
  
              // Construct current comment information
              currentComment.accept(commentVisitor);
  
              // Get CommentRangeEnd from our current comment and construct its information
              CommentRangeEnd commentRangeEnd = (CommentRangeEnd) currentComment.getPreviousSibling();
              commentRangeEnd.accept(commentVisitor);
          }
      }
  
      // Output of all information received
      System.out.println(commentVisitor.getText());
  }
  
  /// <summary>
  /// This Visitor implementation prints information about and contents of comments and comment ranges encountered in the document.
  /// </summary>
  public static class CommentInfoPrinter extends DocumentVisitor {
      public CommentInfoPrinter() {
          mBuilder = new StringBuilder();
          mVisitorIsInsideComment = false;
      }
  
      /// <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 Run node is encountered in the document.
      /// </summary>
      public int visitRun(Run run) {
          if (mVisitorIsInsideComment) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeStart node is encountered in the document.
      /// </summary>
      public int visitCommentRangeStart(CommentRangeStart commentRangeStart) {
          indentAndAppendLine("[Comment range start] ID: " + commentRangeStart.getId());
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeEnd node is encountered in the document.
      /// </summary>
      public int visitCommentRangeEnd(CommentRangeEnd commentRangeEnd) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment range end] ID: " + commentRangeEnd.getId() + "\n");
          mVisitorIsInsideComment = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Comment node is encountered in the document.
      /// </summary>
      public int visitCommentStart(Comment comment) {
          indentAndAppendLine(MessageFormat.format("[Comment start] For comment range ID {0}, By {1} on {2}", comment.getId(),
                  comment.getAuthor(), comment.getDateTime()));
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Comment node is ended in the document.
      /// </summary>
      public int visitCommentEnd(Comment comment) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment end]");
          mVisitorIsInsideComment = false;
  
          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(String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mBuilder.append("|  ");
          }
  
          mBuilder.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideComment;
      private int mDocTraversalDepth;
      private StringBuilder mBuilder;
  }

• getFirstChild

  public Node getFirstChild()
  

  Gets the first child of the node.

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

  Example:

  Shows how to enumerate immediate child nodes of a composite node using NextSibling.

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

  Example:

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

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

• getFirstParagraph

  public Paragraph getFirstParagraph()
  

  Gets the first paragraph in the story.

  Example:

  Shows how to add a comment to a paragraph in the document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.write("Some text is added.");
  
  Date currentDate  = new Date();
  
  Comment comment = new Comment(doc, "Amy Lee", "AL", currentDate);
  builder.getCurrentParagraph().appendChild(comment);
  comment.getParagraphs().add(new Paragraph(doc));
  comment.getFirstParagraph().getRuns().add(new Run(doc, "Comment text."));
  
  doc.save(getArtifactsDir() + "InlineStory.AddComment.docx");

  Example:

  Shows how to add a footnote to a paragraph in the document and set its marker.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Add text that will be referenced by a footnote
  builder.write("Main body text.");
  
  // Add a footnote and give it text, which will appear at the bottom of the page
  Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");
  
  // This attribute means the footnote in the main text will automatically be assigned a number, "1" in this instance
  // The next footnote will get "2"
  Assert.assertTrue(footnote.isAuto());
  
  // We can edit the footnote's text like this
  // Make sure to move the builder back into the document body afterwards
  builder.moveTo(footnote.getFirstParagraph());
  builder.write(" More text added by a DocumentBuilder.");
  builder.moveToDocumentEnd();
  
  Assert.assertEquals(footnote.getParagraphs().get(0).toString(SaveFormat.TEXT).trim(), "Footnote text. More text added by a DocumentBuilder.");
  
  builder.write(" More main body text.");
  footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");
  
  // Substitute the reference number for our own custom mark by setting this variable, "IsAuto" will also be set to false
  footnote.setReferenceMark("RefMark");
  Assert.assertFalse(footnote.isAuto());
  
  // This bookmark will get a number "3" even though there was no "2"
  builder.write(" More main body text.");
  footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");
  Assert.assertTrue(footnote.isAuto());
  
  doc.save(getArtifactsDir() + "InlineStory.AddFootnote.docx");

• getFont

  public Font getFont()
  

  Provides access to the font formatting of the anchor character of this object.

  Example:

  Shows how to insert InlineStory nodes.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);
  
  // Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell
  Table table = new Table(doc);
  table.ensureMinimum();
  
  // We can place a table inside a footnote, which will make it appear at the footer of the referencing page
  Assert.assertEquals(footnote.getTables().getCount(), 0);
  footnote.appendChild(table);
  Assert.assertEquals(footnote.getTables().getCount(), 1);
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);
  
  // An InlineStory has an "EnsureMinimum()" method as well, but in this case it makes sure the last child of the node is a paragraph,
  // so we can click and write text easily in Microsoft Word
  footnote.ensureMinimum();
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Edit the appearance of the anchor, which is the small superscript number in the main text that points to the footnote
  footnote.getFont().setName("Arial");
  footnote.getFont().setColor(Color.GREEN);
  
  // All inline story nodes have their own respective story types
  Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);
  
  // A comment is another type of inline story
  Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));
  
  // The parent paragraph of an inline story node will be the one from the main document body
  Assert.assertEquals(comment.getParentParagraph(), doc.getFirstSection().getBody().getFirstParagraph());
  
  // However, the last paragraph is the one from the comment text contents, which will be outside the main document body in a speech bubble
  // A comment won't have any child nodes by default, so we can apply the EnsureMinimum() method to place a paragraph here as well
  Assert.assertNull(comment.getLastParagraph());
  comment.ensureMinimum();
  Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Once we have a paragraph, we can move the builder do it and write our comment
  builder.moveTo(comment.getLastParagraph());
  builder.write("My comment.");
  
  Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);
  
  doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

• hasChildNodes

  public boolean hasChildNodes()
  

  Returns true if this node has any child nodes.

  Example:

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

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

• getId

  public int getId()
  

  Gets the comment identifier.

  The comment identifier allows to anchor a comment to a region of text in the document. The region must be demarcated using the CommentRangeStart and CommentRangeEnd object sharing the same identifier value as the Comment object.

  You would use this value when looking for the CommentRangeStart and CommentRangeEnd nodes that are linked to this comment.

  Comment identifiers are supposed to be unique across a document and Aspose.Words automatically maintains comment identifiers when loading, saving and combining documents.

  Example:

  Shows how to create comments with replies and get all interested info.

  public void createCommentsAndPrintAllInfo() throws Exception {
      Document doc = new Document();
      doc.removeAllChildren();
  
      Section sect = (Section) doc.appendChild(new Section(doc));
      Body body = (Body) sect.appendChild(new Body(doc));
  
      // Create a commented text with several comment replies
      for (int i = 0; i <= 10; i++) {
          Comment newComment = createComment(doc, "VDeryushev", "VD", new Date(), "My test comment " + i);
  
          Paragraph para = (Paragraph) body.appendChild(new Paragraph(doc));
          para.appendChild(new CommentRangeStart(doc, newComment.getId()));
          para.appendChild(new Run(doc, "Commented text " + i));
          para.appendChild(new CommentRangeEnd(doc, newComment.getId()));
          para.appendChild(newComment);
  
          for (int y = 0; y <= 2; y++) {
              newComment.addReply("John Doe", "JD", new Date(), "New reply " + y);
          }
      }
  
      // Look at information of our comments
      printAllCommentInfo(extractComments(doc));
  }
  
  /// <summary>
  /// Create a new comment.
  /// </summary>
  public static Comment createComment(Document doc, String author, String initials, Date dateTime, String text) {
      Comment newComment = new Comment(doc);
  
      newComment.setAuthor(author);
      newComment.setInitial(initials);
      newComment.setDateTime(dateTime);
      newComment.setText(text);
  
      return newComment;
  }
  
  /// <summary>
  /// Extract comments from the document without replies.
  /// </summary>
  public static ArrayList<Comment> extractComments(Document doc) {
      ArrayList<Comment> collectedComments = new ArrayList<>();
  
      NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
      for (Comment comment : (Iterable<Comment>) comments) {
          // All replies have ancestor, so we will add this check
          if (comment.getAncestor() == null) {
              collectedComments.add(comment);
          }
      }
  
      return collectedComments;
  }
  
  /// <summary>
  /// Use an iterator and a visitor to print info of every comment from within a document.
  /// </summary>
  private static void printAllCommentInfo(ArrayList<Comment> comments) throws Exception {
      // Create an object that inherits from the DocumentVisitor class
      CommentInfoPrinter commentVisitor = new CommentInfoPrinter();
  
      // Get the enumerator from the document's comment collection and iterate over the comments
      Iterator<Comment> enumerator = comments.iterator();
  
      while (enumerator.hasNext()) {
          Comment currentComment = enumerator.next();
  
          // Accept our DocumentVisitor it to print information about our comments
          if (currentComment != null) {
              // Get CommentRangeStart from our current comment and construct its information
              CommentRangeStart commentRangeStart = (CommentRangeStart) currentComment.getPreviousSibling().getPreviousSibling().getPreviousSibling();
              commentRangeStart.accept(commentVisitor);
  
              // Construct current comment information
              currentComment.accept(commentVisitor);
  
              // Get CommentRangeEnd from our current comment and construct its information
              CommentRangeEnd commentRangeEnd = (CommentRangeEnd) currentComment.getPreviousSibling();
              commentRangeEnd.accept(commentVisitor);
          }
      }
  
      // Output of all information received
      System.out.println(commentVisitor.getText());
  }
  
  /// <summary>
  /// This Visitor implementation prints information about and contents of comments and comment ranges encountered in the document.
  /// </summary>
  public static class CommentInfoPrinter extends DocumentVisitor {
      public CommentInfoPrinter() {
          mBuilder = new StringBuilder();
          mVisitorIsInsideComment = false;
      }
  
      /// <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 Run node is encountered in the document.
      /// </summary>
      public int visitRun(Run run) {
          if (mVisitorIsInsideComment) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeStart node is encountered in the document.
      /// </summary>
      public int visitCommentRangeStart(CommentRangeStart commentRangeStart) {
          indentAndAppendLine("[Comment range start] ID: " + commentRangeStart.getId());
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeEnd node is encountered in the document.
      /// </summary>
      public int visitCommentRangeEnd(CommentRangeEnd commentRangeEnd) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment range end] ID: " + commentRangeEnd.getId() + "\n");
          mVisitorIsInsideComment = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Comment node is encountered in the document.
      /// </summary>
      public int visitCommentStart(Comment comment) {
          indentAndAppendLine(MessageFormat.format("[Comment start] For comment range ID {0}, By {1} on {2}", comment.getId(),
                  comment.getAuthor(), comment.getDateTime()));
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Comment node is ended in the document.
      /// </summary>
      public int visitCommentEnd(Comment comment) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment end]");
          mVisitorIsInsideComment = false;
  
          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(String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mBuilder.append("|  ");
          }
  
          mBuilder.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideComment;
      private int mDocTraversalDepth;
      private StringBuilder mBuilder;
  }

• getInitial/setInitial

  public java.lang.String getInitial() / public void setInitial(java.lang.String value)
  

  Returns or sets the initials of the user associated with a specific comment.

  Cannot be null.

  Default is empty string.

  Example:

  Shows how to create comments with replies and get all interested info.

  public void createCommentsAndPrintAllInfo() throws Exception {
      Document doc = new Document();
      doc.removeAllChildren();
  
      Section sect = (Section) doc.appendChild(new Section(doc));
      Body body = (Body) sect.appendChild(new Body(doc));
  
      // Create a commented text with several comment replies
      for (int i = 0; i <= 10; i++) {
          Comment newComment = createComment(doc, "VDeryushev", "VD", new Date(), "My test comment " + i);
  
          Paragraph para = (Paragraph) body.appendChild(new Paragraph(doc));
          para.appendChild(new CommentRangeStart(doc, newComment.getId()));
          para.appendChild(new Run(doc, "Commented text " + i));
          para.appendChild(new CommentRangeEnd(doc, newComment.getId()));
          para.appendChild(newComment);
  
          for (int y = 0; y <= 2; y++) {
              newComment.addReply("John Doe", "JD", new Date(), "New reply " + y);
          }
      }
  
      // Look at information of our comments
      printAllCommentInfo(extractComments(doc));
  }
  
  /// <summary>
  /// Create a new comment.
  /// </summary>
  public static Comment createComment(Document doc, String author, String initials, Date dateTime, String text) {
      Comment newComment = new Comment(doc);
  
      newComment.setAuthor(author);
      newComment.setInitial(initials);
      newComment.setDateTime(dateTime);
      newComment.setText(text);
  
      return newComment;
  }
  
  /// <summary>
  /// Extract comments from the document without replies.
  /// </summary>
  public static ArrayList<Comment> extractComments(Document doc) {
      ArrayList<Comment> collectedComments = new ArrayList<>();
  
      NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
      for (Comment comment : (Iterable<Comment>) comments) {
          // All replies have ancestor, so we will add this check
          if (comment.getAncestor() == null) {
              collectedComments.add(comment);
          }
      }
  
      return collectedComments;
  }
  
  /// <summary>
  /// Use an iterator and a visitor to print info of every comment from within a document.
  /// </summary>
  private static void printAllCommentInfo(ArrayList<Comment> comments) throws Exception {
      // Create an object that inherits from the DocumentVisitor class
      CommentInfoPrinter commentVisitor = new CommentInfoPrinter();
  
      // Get the enumerator from the document's comment collection and iterate over the comments
      Iterator<Comment> enumerator = comments.iterator();
  
      while (enumerator.hasNext()) {
          Comment currentComment = enumerator.next();
  
          // Accept our DocumentVisitor it to print information about our comments
          if (currentComment != null) {
              // Get CommentRangeStart from our current comment and construct its information
              CommentRangeStart commentRangeStart = (CommentRangeStart) currentComment.getPreviousSibling().getPreviousSibling().getPreviousSibling();
              commentRangeStart.accept(commentVisitor);
  
              // Construct current comment information
              currentComment.accept(commentVisitor);
  
              // Get CommentRangeEnd from our current comment and construct its information
              CommentRangeEnd commentRangeEnd = (CommentRangeEnd) currentComment.getPreviousSibling();
              commentRangeEnd.accept(commentVisitor);
          }
      }
  
      // Output of all information received
      System.out.println(commentVisitor.getText());
  }
  
  /// <summary>
  /// This Visitor implementation prints information about and contents of comments and comment ranges encountered in the document.
  /// </summary>
  public static class CommentInfoPrinter extends DocumentVisitor {
      public CommentInfoPrinter() {
          mBuilder = new StringBuilder();
          mVisitorIsInsideComment = false;
      }
  
      /// <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 Run node is encountered in the document.
      /// </summary>
      public int visitRun(Run run) {
          if (mVisitorIsInsideComment) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeStart node is encountered in the document.
      /// </summary>
      public int visitCommentRangeStart(CommentRangeStart commentRangeStart) {
          indentAndAppendLine("[Comment range start] ID: " + commentRangeStart.getId());
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeEnd node is encountered in the document.
      /// </summary>
      public int visitCommentRangeEnd(CommentRangeEnd commentRangeEnd) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment range end] ID: " + commentRangeEnd.getId() + "\n");
          mVisitorIsInsideComment = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Comment node is encountered in the document.
      /// </summary>
      public int visitCommentStart(Comment comment) {
          indentAndAppendLine(MessageFormat.format("[Comment start] For comment range ID {0}, By {1} on {2}", comment.getId(),
                  comment.getAuthor(), comment.getDateTime()));
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Comment node is ended in the document.
      /// </summary>
      public int visitCommentEnd(Comment comment) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment end]");
          mVisitorIsInsideComment = false;
  
          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(String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mBuilder.append("|  ");
          }
  
          mBuilder.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideComment;
      private int mDocTraversalDepth;
      private StringBuilder mBuilder;
  }

• isComposite

  public boolean isComposite()
  

  Returns true as this node can have child nodes.

  Example:

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

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

• isDeleteRevision

  public boolean isDeleteRevision()
  

  Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

  Example:

  Shows how to view revision-related properties of InlineStory nodes.

  // Open a document that has revisions from changes being tracked
  Document doc = new Document(getMyDir() + "Revision footnotes.docx");
  Assert.assertTrue(doc.hasRevisions());
  
  // Get a collection of all footnotes from the document
  NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true);
  Assert.assertEquals(5, footnotes.getCount());
  
  // If a node was inserted in Microsoft Word while changes were being tracked, this flag will be set to true
  Footnote footnote = (Footnote) footnotes.get(2);
  Assert.assertTrue(footnote.isInsertRevision());
  
  // If one node was moved from one place to another while changes were tracked,
  // the node will be placed at the departure location as a "move to revision",
  // and a "move from revision" node will be left behind at the origin, in case we want to reject changes
  // Highlighting text and dragging it to another place with the mouse and cut-and-pasting (but not copy-pasting) both count as "move revisions"
  // The node with the "IsMoveToRevision" flag is the arrival of the move operation, and the node with the "IsMoveFromRevision" flag is the departure point
  footnote = (Footnote) footnotes.get(1);
  Assert.assertTrue(footnote.isMoveToRevision());
  footnote = (Footnote) footnotes.get(4);
  Assert.assertTrue(footnote.isMoveFromRevision());
  
  // If a node was deleted while changes were being tracked, it will stay behind as a delete revision until we accept/reject changes
  footnote = (Footnote) footnotes.get(3);
  Assert.assertTrue(footnote.isDeleteRevision());

• isInsertRevision

  public boolean isInsertRevision()
  

  Returns true if this object was inserted in Microsoft Word while change tracking was enabled.

  Example:

  Shows how to view revision-related properties of InlineStory nodes.

  // Open a document that has revisions from changes being tracked
  Document doc = new Document(getMyDir() + "Revision footnotes.docx");
  Assert.assertTrue(doc.hasRevisions());
  
  // Get a collection of all footnotes from the document
  NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true);
  Assert.assertEquals(5, footnotes.getCount());
  
  // If a node was inserted in Microsoft Word while changes were being tracked, this flag will be set to true
  Footnote footnote = (Footnote) footnotes.get(2);
  Assert.assertTrue(footnote.isInsertRevision());
  
  // If one node was moved from one place to another while changes were tracked,
  // the node will be placed at the departure location as a "move to revision",
  // and a "move from revision" node will be left behind at the origin, in case we want to reject changes
  // Highlighting text and dragging it to another place with the mouse and cut-and-pasting (but not copy-pasting) both count as "move revisions"
  // The node with the "IsMoveToRevision" flag is the arrival of the move operation, and the node with the "IsMoveFromRevision" flag is the departure point
  footnote = (Footnote) footnotes.get(1);
  Assert.assertTrue(footnote.isMoveToRevision());
  footnote = (Footnote) footnotes.get(4);
  Assert.assertTrue(footnote.isMoveFromRevision());
  
  // If a node was deleted while changes were being tracked, it will stay behind as a delete revision until we accept/reject changes
  footnote = (Footnote) footnotes.get(3);
  Assert.assertTrue(footnote.isDeleteRevision());

• isMoveFromRevision

  public boolean isMoveFromRevision()
  

  Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.

  Example:

  Shows how to view revision-related properties of InlineStory nodes.

  // Open a document that has revisions from changes being tracked
  Document doc = new Document(getMyDir() + "Revision footnotes.docx");
  Assert.assertTrue(doc.hasRevisions());
  
  // Get a collection of all footnotes from the document
  NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true);
  Assert.assertEquals(5, footnotes.getCount());
  
  // If a node was inserted in Microsoft Word while changes were being tracked, this flag will be set to true
  Footnote footnote = (Footnote) footnotes.get(2);
  Assert.assertTrue(footnote.isInsertRevision());
  
  // If one node was moved from one place to another while changes were tracked,
  // the node will be placed at the departure location as a "move to revision",
  // and a "move from revision" node will be left behind at the origin, in case we want to reject changes
  // Highlighting text and dragging it to another place with the mouse and cut-and-pasting (but not copy-pasting) both count as "move revisions"
  // The node with the "IsMoveToRevision" flag is the arrival of the move operation, and the node with the "IsMoveFromRevision" flag is the departure point
  footnote = (Footnote) footnotes.get(1);
  Assert.assertTrue(footnote.isMoveToRevision());
  footnote = (Footnote) footnotes.get(4);
  Assert.assertTrue(footnote.isMoveFromRevision());
  
  // If a node was deleted while changes were being tracked, it will stay behind as a delete revision until we accept/reject changes
  footnote = (Footnote) footnotes.get(3);
  Assert.assertTrue(footnote.isDeleteRevision());

• isMoveToRevision

  public boolean isMoveToRevision()
  

  Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.

  Example:

  Shows how to view revision-related properties of InlineStory nodes.

  // Open a document that has revisions from changes being tracked
  Document doc = new Document(getMyDir() + "Revision footnotes.docx");
  Assert.assertTrue(doc.hasRevisions());
  
  // Get a collection of all footnotes from the document
  NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true);
  Assert.assertEquals(5, footnotes.getCount());
  
  // If a node was inserted in Microsoft Word while changes were being tracked, this flag will be set to true
  Footnote footnote = (Footnote) footnotes.get(2);
  Assert.assertTrue(footnote.isInsertRevision());
  
  // If one node was moved from one place to another while changes were tracked,
  // the node will be placed at the departure location as a "move to revision",
  // and a "move from revision" node will be left behind at the origin, in case we want to reject changes
  // Highlighting text and dragging it to another place with the mouse and cut-and-pasting (but not copy-pasting) both count as "move revisions"
  // The node with the "IsMoveToRevision" flag is the arrival of the move operation, and the node with the "IsMoveFromRevision" flag is the departure point
  footnote = (Footnote) footnotes.get(1);
  Assert.assertTrue(footnote.isMoveToRevision());
  footnote = (Footnote) footnotes.get(4);
  Assert.assertTrue(footnote.isMoveFromRevision());
  
  // If a node was deleted while changes were being tracked, it will stay behind as a delete revision until we accept/reject changes
  footnote = (Footnote) footnotes.get(3);
  Assert.assertTrue(footnote.isDeleteRevision());

• getLastChild

  public Node getLastChild()
  

  Gets the last child of the node.

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

  Example:

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

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

• getLastParagraph

  public Paragraph getLastParagraph()
  

  Gets the last paragraph in the story.

  Example:

  Shows how to insert InlineStory nodes.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);
  
  // Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell
  Table table = new Table(doc);
  table.ensureMinimum();
  
  // We can place a table inside a footnote, which will make it appear at the footer of the referencing page
  Assert.assertEquals(footnote.getTables().getCount(), 0);
  footnote.appendChild(table);
  Assert.assertEquals(footnote.getTables().getCount(), 1);
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);
  
  // An InlineStory has an "EnsureMinimum()" method as well, but in this case it makes sure the last child of the node is a paragraph,
  // so we can click and write text easily in Microsoft Word
  footnote.ensureMinimum();
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Edit the appearance of the anchor, which is the small superscript number in the main text that points to the footnote
  footnote.getFont().setName("Arial");
  footnote.getFont().setColor(Color.GREEN);
  
  // All inline story nodes have their own respective story types
  Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);
  
  // A comment is another type of inline story
  Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));
  
  // The parent paragraph of an inline story node will be the one from the main document body
  Assert.assertEquals(comment.getParentParagraph(), doc.getFirstSection().getBody().getFirstParagraph());
  
  // However, the last paragraph is the one from the comment text contents, which will be outside the main document body in a speech bubble
  // A comment won't have any child nodes by default, so we can apply the EnsureMinimum() method to place a paragraph here as well
  Assert.assertNull(comment.getLastParagraph());
  comment.ensureMinimum();
  Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Once we have a paragraph, we can move the builder do it and write our comment
  builder.moveTo(comment.getLastParagraph());
  builder.write("My comment.");
  
  Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);
  
  doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

• getNextSibling

  public Node getNextSibling()
  

  Gets the node immediately following this node.

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

  Example:

  Shows how to enumerate immediate child nodes of a composite node using NextSibling.

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

  Example:

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

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

• getNodeType

  public int getNodeType()
  

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

  Example:

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

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

• getParagraphs

  public ParagraphCollection getParagraphs()
  

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

  Example:

  Shows how to add a comment to a paragraph in the document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.write("Some text is added.");
  
  Date currentDate  = new Date();
  
  Comment comment = new Comment(doc, "Amy Lee", "AL", currentDate);
  builder.getCurrentParagraph().appendChild(comment);
  comment.getParagraphs().add(new Paragraph(doc));
  comment.getFirstParagraph().getRuns().add(new Run(doc, "Comment text."));
  
  doc.save(getArtifactsDir() + "InlineStory.AddComment.docx");

  Example:

  Shows how to add a footnote to a paragraph in the document and set its marker.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Add text that will be referenced by a footnote
  builder.write("Main body text.");
  
  // Add a footnote and give it text, which will appear at the bottom of the page
  Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");
  
  // This attribute means the footnote in the main text will automatically be assigned a number, "1" in this instance
  // The next footnote will get "2"
  Assert.assertTrue(footnote.isAuto());
  
  // We can edit the footnote's text like this
  // Make sure to move the builder back into the document body afterwards
  builder.moveTo(footnote.getFirstParagraph());
  builder.write(" More text added by a DocumentBuilder.");
  builder.moveToDocumentEnd();
  
  Assert.assertEquals(footnote.getParagraphs().get(0).toString(SaveFormat.TEXT).trim(), "Footnote text. More text added by a DocumentBuilder.");
  
  builder.write(" More main body text.");
  footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");
  
  // Substitute the reference number for our own custom mark by setting this variable, "IsAuto" will also be set to false
  footnote.setReferenceMark("RefMark");
  Assert.assertFalse(footnote.isAuto());
  
  // This bookmark will get a number "3" even though there was no "2"
  builder.write(" More main body text.");
  footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text.");
  Assert.assertTrue(footnote.isAuto());
  
  doc.save(getArtifactsDir() + "InlineStory.AddFootnote.docx");

• getParentNode

  public CompositeNode getParentNode()
  

  Gets the immediate parent of this node.

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

  Example:

  Shows how to access the parent node.

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

  Example:

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

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

• getParentParagraph

  public Paragraph getParentParagraph()
  

  Retrieves the parent Paragraph of this node.

  Example:

  Shows how to insert InlineStory nodes.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);
  
  // Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell
  Table table = new Table(doc);
  table.ensureMinimum();
  
  // We can place a table inside a footnote, which will make it appear at the footer of the referencing page
  Assert.assertEquals(footnote.getTables().getCount(), 0);
  footnote.appendChild(table);
  Assert.assertEquals(footnote.getTables().getCount(), 1);
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);
  
  // An InlineStory has an "EnsureMinimum()" method as well, but in this case it makes sure the last child of the node is a paragraph,
  // so we can click and write text easily in Microsoft Word
  footnote.ensureMinimum();
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Edit the appearance of the anchor, which is the small superscript number in the main text that points to the footnote
  footnote.getFont().setName("Arial");
  footnote.getFont().setColor(Color.GREEN);
  
  // All inline story nodes have their own respective story types
  Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);
  
  // A comment is another type of inline story
  Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));
  
  // The parent paragraph of an inline story node will be the one from the main document body
  Assert.assertEquals(comment.getParentParagraph(), doc.getFirstSection().getBody().getFirstParagraph());
  
  // However, the last paragraph is the one from the comment text contents, which will be outside the main document body in a speech bubble
  // A comment won't have any child nodes by default, so we can apply the EnsureMinimum() method to place a paragraph here as well
  Assert.assertNull(comment.getLastParagraph());
  comment.ensureMinimum();
  Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Once we have a paragraph, we can move the builder do it and write our comment
  builder.moveTo(comment.getLastParagraph());
  builder.write("My comment.");
  
  Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);
  
  doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

• getPreviousSibling

  public Node getPreviousSibling()
  

  Gets the node immediately preceding this node.

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

  Example:

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

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

• getRange

  public Range getRange()
  

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

  Example:

  Shows how to delete all characters of a range.

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

• getReplies

  public CommentCollection getReplies()
  

  Returns a collection of Comment objects that are immediate children of the specified comment.

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

• getStoryType

  public int getStoryType()
  

  Returns StoryType.Comments. The value of the property is StoryType integer constant.

  Example:

  Shows how to insert InlineStory nodes.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);
  
  // Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell
  Table table = new Table(doc);
  table.ensureMinimum();
  
  // We can place a table inside a footnote, which will make it appear at the footer of the referencing page
  Assert.assertEquals(footnote.getTables().getCount(), 0);
  footnote.appendChild(table);
  Assert.assertEquals(footnote.getTables().getCount(), 1);
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);
  
  // An InlineStory has an "EnsureMinimum()" method as well, but in this case it makes sure the last child of the node is a paragraph,
  // so we can click and write text easily in Microsoft Word
  footnote.ensureMinimum();
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Edit the appearance of the anchor, which is the small superscript number in the main text that points to the footnote
  footnote.getFont().setName("Arial");
  footnote.getFont().setColor(Color.GREEN);
  
  // All inline story nodes have their own respective story types
  Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);
  
  // A comment is another type of inline story
  Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));
  
  // The parent paragraph of an inline story node will be the one from the main document body
  Assert.assertEquals(comment.getParentParagraph(), doc.getFirstSection().getBody().getFirstParagraph());
  
  // However, the last paragraph is the one from the comment text contents, which will be outside the main document body in a speech bubble
  // A comment won't have any child nodes by default, so we can apply the EnsureMinimum() method to place a paragraph here as well
  Assert.assertNull(comment.getLastParagraph());
  comment.ensureMinimum();
  Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Once we have a paragraph, we can move the builder do it and write our comment
  builder.moveTo(comment.getLastParagraph());
  builder.write("My comment.");
  
  Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);
  
  doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

• getTables

  public TableCollection getTables()
  

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

  Example:

  Shows how to insert InlineStory nodes.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);
  
  // Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell
  Table table = new Table(doc);
  table.ensureMinimum();
  
  // We can place a table inside a footnote, which will make it appear at the footer of the referencing page
  Assert.assertEquals(footnote.getTables().getCount(), 0);
  footnote.appendChild(table);
  Assert.assertEquals(footnote.getTables().getCount(), 1);
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);
  
  // An InlineStory has an "EnsureMinimum()" method as well, but in this case it makes sure the last child of the node is a paragraph,
  // so we can click and write text easily in Microsoft Word
  footnote.ensureMinimum();
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Edit the appearance of the anchor, which is the small superscript number in the main text that points to the footnote
  footnote.getFont().setName("Arial");
  footnote.getFont().setColor(Color.GREEN);
  
  // All inline story nodes have their own respective story types
  Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);
  
  // A comment is another type of inline story
  Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));
  
  // The parent paragraph of an inline story node will be the one from the main document body
  Assert.assertEquals(comment.getParentParagraph(), doc.getFirstSection().getBody().getFirstParagraph());
  
  // However, the last paragraph is the one from the comment text contents, which will be outside the main document body in a speech bubble
  // A comment won't have any child nodes by default, so we can apply the EnsureMinimum() method to place a paragraph here as well
  Assert.assertNull(comment.getLastParagraph());
  comment.ensureMinimum();
  Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Once we have a paragraph, we can move the builder do it and write our comment
  builder.moveTo(comment.getLastParagraph());
  builder.write("My comment.");
  
  Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);
  
  doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

Method Detail

• accept

  public boolean accept(DocumentVisitor visitor)
                throws java.lang.Exception

  Accepts a visitor.

  Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

  For more info see the Visitor design pattern.

  Calls DocumentVisitor.visitCommentStart(com.aspose.words.Comment), then calls accept(com.aspose.words.DocumentVisitor) for all child nodes of the comment and calls DocumentVisitor.visitCommentEnd(com.aspose.words.Comment) at the end.

  Parameters:

  visitor - The visitor that will visit the nodes.

  Returns:

  True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

  Example:

  Shows how to create comments with replies and get all interested info.

  public void createCommentsAndPrintAllInfo() throws Exception {
      Document doc = new Document();
      doc.removeAllChildren();
  
      Section sect = (Section) doc.appendChild(new Section(doc));
      Body body = (Body) sect.appendChild(new Body(doc));
  
      // Create a commented text with several comment replies
      for (int i = 0; i <= 10; i++) {
          Comment newComment = createComment(doc, "VDeryushev", "VD", new Date(), "My test comment " + i);
  
          Paragraph para = (Paragraph) body.appendChild(new Paragraph(doc));
          para.appendChild(new CommentRangeStart(doc, newComment.getId()));
          para.appendChild(new Run(doc, "Commented text " + i));
          para.appendChild(new CommentRangeEnd(doc, newComment.getId()));
          para.appendChild(newComment);
  
          for (int y = 0; y <= 2; y++) {
              newComment.addReply("John Doe", "JD", new Date(), "New reply " + y);
          }
      }
  
      // Look at information of our comments
      printAllCommentInfo(extractComments(doc));
  }
  
  /// <summary>
  /// Create a new comment.
  /// </summary>
  public static Comment createComment(Document doc, String author, String initials, Date dateTime, String text) {
      Comment newComment = new Comment(doc);
  
      newComment.setAuthor(author);
      newComment.setInitial(initials);
      newComment.setDateTime(dateTime);
      newComment.setText(text);
  
      return newComment;
  }
  
  /// <summary>
  /// Extract comments from the document without replies.
  /// </summary>
  public static ArrayList<Comment> extractComments(Document doc) {
      ArrayList<Comment> collectedComments = new ArrayList<>();
  
      NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
      for (Comment comment : (Iterable<Comment>) comments) {
          // All replies have ancestor, so we will add this check
          if (comment.getAncestor() == null) {
              collectedComments.add(comment);
          }
      }
  
      return collectedComments;
  }
  
  /// <summary>
  /// Use an iterator and a visitor to print info of every comment from within a document.
  /// </summary>
  private static void printAllCommentInfo(ArrayList<Comment> comments) throws Exception {
      // Create an object that inherits from the DocumentVisitor class
      CommentInfoPrinter commentVisitor = new CommentInfoPrinter();
  
      // Get the enumerator from the document's comment collection and iterate over the comments
      Iterator<Comment> enumerator = comments.iterator();
  
      while (enumerator.hasNext()) {
          Comment currentComment = enumerator.next();
  
          // Accept our DocumentVisitor it to print information about our comments
          if (currentComment != null) {
              // Get CommentRangeStart from our current comment and construct its information
              CommentRangeStart commentRangeStart = (CommentRangeStart) currentComment.getPreviousSibling().getPreviousSibling().getPreviousSibling();
              commentRangeStart.accept(commentVisitor);
  
              // Construct current comment information
              currentComment.accept(commentVisitor);
  
              // Get CommentRangeEnd from our current comment and construct its information
              CommentRangeEnd commentRangeEnd = (CommentRangeEnd) currentComment.getPreviousSibling();
              commentRangeEnd.accept(commentVisitor);
          }
      }
  
      // Output of all information received
      System.out.println(commentVisitor.getText());
  }
  
  /// <summary>
  /// This Visitor implementation prints information about and contents of comments and comment ranges encountered in the document.
  /// </summary>
  public static class CommentInfoPrinter extends DocumentVisitor {
      public CommentInfoPrinter() {
          mBuilder = new StringBuilder();
          mVisitorIsInsideComment = false;
      }
  
      /// <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 Run node is encountered in the document.
      /// </summary>
      public int visitRun(Run run) {
          if (mVisitorIsInsideComment) indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeStart node is encountered in the document.
      /// </summary>
      public int visitCommentRangeStart(CommentRangeStart commentRangeStart) {
          indentAndAppendLine("[Comment range start] ID: " + commentRangeStart.getId());
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a CommentRangeEnd node is encountered in the document.
      /// </summary>
      public int visitCommentRangeEnd(CommentRangeEnd commentRangeEnd) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment range end] ID: " + commentRangeEnd.getId() + "\n");
          mVisitorIsInsideComment = false;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Comment node is encountered in the document.
      /// </summary>
      public int visitCommentStart(Comment comment) {
          indentAndAppendLine(MessageFormat.format("[Comment start] For comment range ID {0}, By {1} on {2}", comment.getId(),
                  comment.getAuthor(), comment.getDateTime()));
          mDocTraversalDepth++;
          mVisitorIsInsideComment = true;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Comment node is ended in the document.
      /// </summary>
      public int visitCommentEnd(Comment comment) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Comment end]");
          mVisitorIsInsideComment = false;
  
          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(String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mBuilder.append("|  ");
          }
  
          mBuilder.append(text + "\r\n");
      }
  
      private boolean mVisitorIsInsideComment;
      private int mDocTraversalDepth;
      private StringBuilder mBuilder;
  }

• addReply

  public Comment addReply(java.lang.String author, java.lang.String initial, java.util.Date dateTime, java.lang.String text)
                  throws java.lang.Exception

  Adds a reply to this comment.

  Due to the existing MS Office limitations only 1 level of replies is allowed in the document. An exception of type System.InvalidOperationException will be raised if this method is called on the existing Reply comment.

  Parameters:

  author - The author name for the reply.

  initial - The author initials for the reply.

  dateTime - The date and time for the reply.

  text - The reply text.

  Returns:

  The created Comment node for the reply.

  Example:

  Shows how to add a comment with a reply to a document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Create new comment
  Comment newComment = new Comment(doc, "John Doe", "J.D.", new Date(System.currentTimeMillis()));
  newComment.setText("My comment.");
  
  // Add this comment to a document node
  builder.getCurrentParagraph().appendChild(newComment);
  
  Calendar cal = Calendar.getInstance();
  cal.set(2017, Calendar.SEPTEMBER, 25, 12, 15, 0);
  cal.getTime();
  
  // Add comment reply
  newComment.addReply("John Doe", "JD", cal.getTime(), "New reply");

• appendChild

  public Node appendChild(Node newChild)

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

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

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

  Parameters:

  newChild - The node to add.

  Returns:

  The node added.

  Example:

  Shows how to construct an Aspose Words document node by node.

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

• deepClone

  public Node deepClone(boolean isCloneChildren)

  Example:

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

  Document doc = new Document();
  Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
  para.appendChild(new Run(doc, "Hello world!"));
  
  // Clone the paragraph and the child nodes
  Node cloneWithChildren = para.deepClone(true);
  
  Assert.assertTrue(((CompositeNode)cloneWithChildren).hasChildNodes());
  Assert.assertEquals("Hello world!", cloneWithChildren.getText().trim());
  
  // Clone the paragraph without its clild nodes
  Node cloneWithoutChildren = para.deepClone(false);
  
  Assert.assertFalse(((CompositeNode)cloneWithoutChildren).hasChildNodes());
  Assert.assertEquals("", cloneWithoutChildren.getText().trim());

• ensureMinimum

  public void ensureMinimum()

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

  Example:

  Shows how to insert InlineStory nodes.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, null);
  
  // Table nodes have an "EnsureMinimum()" method that makes sure the table has at least one cell
  Table table = new Table(doc);
  table.ensureMinimum();
  
  // We can place a table inside a footnote, which will make it appear at the footer of the referencing page
  Assert.assertEquals(footnote.getTables().getCount(), 0);
  footnote.appendChild(table);
  Assert.assertEquals(footnote.getTables().getCount(), 1);
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.TABLE);
  
  // An InlineStory has an "EnsureMinimum()" method as well, but in this case it makes sure the last child of the node is a paragraph,
  // so we can click and write text easily in Microsoft Word
  footnote.ensureMinimum();
  Assert.assertEquals(footnote.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Edit the appearance of the anchor, which is the small superscript number in the main text that points to the footnote
  footnote.getFont().setName("Arial");
  footnote.getFont().setColor(Color.GREEN);
  
  // All inline story nodes have their own respective story types
  Assert.assertEquals(footnote.getStoryType(), StoryType.FOOTNOTES);
  
  // A comment is another type of inline story
  Comment comment = (Comment) builder.getCurrentParagraph().appendChild(new Comment(doc, "John Doe", "J. D.", new Date()));
  
  // The parent paragraph of an inline story node will be the one from the main document body
  Assert.assertEquals(comment.getParentParagraph(), doc.getFirstSection().getBody().getFirstParagraph());
  
  // However, the last paragraph is the one from the comment text contents, which will be outside the main document body in a speech bubble
  // A comment won't have any child nodes by default, so we can apply the EnsureMinimum() method to place a paragraph here as well
  Assert.assertNull(comment.getLastParagraph());
  comment.ensureMinimum();
  Assert.assertEquals(comment.getLastChild().getNodeType(), NodeType.PARAGRAPH);
  
  // Once we have a paragraph, we can move the builder do it and write our comment
  builder.moveTo(comment.getLastParagraph());
  builder.write("My comment.");
  
  Assert.assertEquals(comment.getStoryType(), StoryType.COMMENTS);
  
  doc.save(getArtifactsDir() + "InlineStory.InsertInlineStoryNodes.docx");

• 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 expand the formatting from styles onto the rows and cells of the table as direct formatting.

  Document doc = new Document(getMyDir() + "Tables.docx");
  Table table = (Table)doc.getChild(NodeType.TABLE, 0, true);
  
  // First print the color of the cell shading. This should be empty as the current shading
  // is stored in the table style
  double cellShadingBefore = table.getFirstRow().getRowFormat().getHeight();
  System.out.println("Cell shading before style expansion: " + cellShadingBefore);
  
  // Expand table style formatting to direct formatting
  doc.expandTableStylesToDirectFormatting();
  
  // Now print the cell shading after expanding table styles. A blue background pattern color
  // should have been applied from the table style
  double cellShadingAfter = table.getFirstRow().getRowFormat().getHeight();
  System.out.println("Cell shading after style expansion: " + cellShadingAfter);
  
  doc.save(getArtifactsDir() + "Document.TableStyleToDirectFormatting.docx");

  Example:

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

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

• getChildNodes

  public NodeCollection getChildNodes(int nodeType, boolean isDeep)

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

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

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

  Parameters:

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

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

  Returns:

  A live collection of child nodes of the specified type.

  Example:

  Shows how to 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.

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

• getText

  public java.lang.String getText()

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

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

  Example:

  Shows how to output all paragraphs in a document that are bulleted or numbered.

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

  Example:

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

  Document doc = new Document();
  
  // 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));

• indexOf

  public int indexOf(Node child)

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

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

  Example:

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

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

• insertAfter

  public Node insertAfter(Node newChild, Node refChild)

  Inserts the specified node immediately after the specified reference node.

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

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

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

  Parameters:

  newChild - The Node to insert.

  refChild - The Node that is the reference node. The newNode is placed after the refNode.

  Returns:

  The inserted node.

  Example:

  Shows how to replace all textboxes with images.

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

  Example:

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

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

• insertBefore

  public Node insertBefore(Node newChild, Node refChild)

  Inserts the specified node immediately before the specified reference node.

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

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

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

  Parameters:

  newChild - The Node to insert.

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

  Returns:

  The inserted node.

  Example:

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

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

• iterator

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

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

  Example:

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

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

• nextPreOrder

  public Node nextPreOrder(Node rootNode)

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

  Parameters:

  rootNode - The top node (limit) of traversal.

  Returns:

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

  Example:

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

  Document doc = new Document(getMyDir() + "Images.docx");
  Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10);
  
  Node curNode = doc;
  while (curNode != null) {
      Node nextNode = curNode.nextPreOrder(doc);
  
      if (curNode.previousPreOrder(doc) != null && nextNode != null) {
          Assert.assertEquals(curNode, nextNode.previousPreOrder(doc));
      }
  
      if (curNode.getNodeType() == NodeType.SHAPE) {
          Shape shape = (Shape) curNode;
  
          // Several shape types can have an image including image shapes and OLE objects
          if (shape.hasImage()) {
              shape.remove();
          }
      }
  
      curNode = nextNode;
  }
  
  // The only remaining shape doesn't have an image
  Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());

• prependChild

  public Node prependChild(Node newChild)

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

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

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

  Parameters:

  newChild - The node to add.

  Returns:

  The node added.

  Example:

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

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

• previousPreOrder

  public Node previousPreOrder(Node rootNode)

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

  Parameters:

  rootNode - The top node (limit) of traversal.

  Returns:

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

  Example:

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

  Document doc = new Document(getMyDir() + "Images.docx");
  Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10);
  
  Node curNode = doc;
  while (curNode != null) {
      Node nextNode = curNode.nextPreOrder(doc);
  
      if (curNode.previousPreOrder(doc) != null && nextNode != null) {
          Assert.assertEquals(curNode, nextNode.previousPreOrder(doc));
      }
  
      if (curNode.getNodeType() == NodeType.SHAPE) {
          Shape shape = (Shape) curNode;
  
          // Several shape types can have an image including image shapes and OLE objects
          if (shape.hasImage()) {
              shape.remove();
          }
      }
  
      curNode = nextNode;
  }
  
  // The only remaining shape doesn't have an image
  Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());

• remove

  public void remove()

  Removes itself from the parent.

  Example:

  Shows how to delete all images from a document.

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

  Example:

  Shows how to remove all nodes of a specific type from a composite node.

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

• removeAllChildren

  public void removeAllChildren()

  Removes all the child nodes of the current node.

  Example:

  Shows how to construct an Aspose Words document node by node.

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

• removeAllReplies

  public void removeAllReplies()
                       throws java.lang.Exception

  Removes all replies to this comment.

  All constituent nodes of the replies will be deleted from the document.

  Example:

  Shows how to remove comment replies.

  Document doc = new Document(getMyDir() + "Comments.docx");
  
  NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  Comment comment = (Comment) comments.get(0);
  
  comment.removeAllReplies();

• removeChild

  public Node removeChild(Node oldChild)

  Removes the specified child node.

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

  Parameters:

  oldChild - The node to remove.

  Returns:

  The removed node.

  Example:

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

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

• removeReply

  public void removeReply(Comment reply)
                  throws java.lang.Exception

  Removes the specified reply to this comment.

  All constituent nodes of the reply will be deleted from the document.

  Parameters:

  reply - The comment node of the deleting reply.

  Example:

  Shows how to remove specific comment reply.

  Document doc = new Document(getMyDir() + "Comments.docx");
  
  NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
  Comment parentComment = (Comment) comments.get(0);
  CommentCollection repliesCollection = parentComment.getReplies();
  
  // Remove the first reply to comment
  parentComment.removeReply(repliesCollection.get(0));

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

  Shows how to create smart tags.

  public void smartTags() throws Exception {
      Document doc = new Document();
      SmartTag smartTag = new SmartTag(doc);
      smartTag.setElement("date");
  
      // Specify a date and set smart tag properties accordingly
      smartTag.appendChild(new Run(doc, "May 29, 2019"));
  
      smartTag.getProperties().add(new CustomXmlProperty("Day", "", "29"));
      smartTag.getProperties().add(new CustomXmlProperty("Month", "", "5"));
      smartTag.getProperties().add(new CustomXmlProperty("Year", "", "2019"));
  
      // Set the smart tag's uri to the default
      smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");
  
      doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
      doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a date. "));
  
      // Create and add one more smart tag, this time for a financial symbol
      smartTag = new SmartTag(doc);
      smartTag.setElement("stockticker");
      smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");
  
      smartTag.appendChild(new Run(doc, "MSFT"));
  
      doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
      doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a stock ticker."));
  
      // Print all the smart tags in our document with a document visitor
      doc.accept(new SmartTagVisitor());
  
      // SmartTags are supported by older versions of microsoft Word
      doc.save(getArtifactsDir() + "StructuredDocumentTag.SmartTags.doc");
  
      // We can strip a document of all its smart tags with RemoveSmartTags()
      Assert.assertEquals(2, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
      doc.removeSmartTags();
      Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
  }
  
  /// <summary>
  /// DocumentVisitor implementation that prints smart tags and their contents.
  /// </summary>
  private static class SmartTagVisitor extends DocumentVisitor {
      /// <summary>
      /// Called when a SmartTag node is encountered in the document.
      /// </summary>
      public int visitSmartTagStart(SmartTag smartTag) {
          System.out.println(MessageFormat.format("Smart tag type: {0}", smartTag.getElement()));
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a SmartTag node is ended.
      /// </summary>
      public int visitSmartTagEnd(SmartTag smartTag) throws Exception {
          System.out.println(MessageFormat.format("\tContents: \"{0}\"", smartTag.toString(SaveFormat.TEXT)));
  
          if (smartTag.getProperties().getCount() == 0) {
              System.out.println("\tContains no properties");
  
          } else {
              System.out.println("\tProperties: ");
              String[] properties = new String[smartTag.getProperties().getCount()];
              int index = 0;
  
              for (CustomXmlProperty cxp : smartTag.getProperties()) {
                  properties[index++] = MessageFormat.format("\"{0}\" = \"{1}\"", cxp.getName(), cxp.getValue());
              }
  
              System.out.println(String.join(", ", properties));
          }
  
          return VisitorAction.CONTINUE;
      }
  }

  Example:

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

  Document doc = new Document(getMyDir() + "Smart tags.doc");
  Assert.assertEquals(8, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
  
  // Remove smart tags from the whole document
  doc.removeSmartTags();
  
  Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());

• selectNodes

  public NodeList selectNodes(java.lang.String xpath)

  Selects a list of nodes matching the XPath expression.

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

  Parameters:

  xpath - The XPath expression.

  Returns:

  A list of nodes matching the XPath query.

  Example:

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

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

  Example:

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

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

• selectSingleNode

  public Node selectSingleNode(java.lang.String xpath)

  Selects the first Node that matches the XPath expression.

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

  Parameters:

  xpath - The XPath expression.

  Returns:

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

  Example:

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

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

• setText

  public void setText(java.lang.String text)

  This is a convenience method that allows to easily set text of the comment.

  This method allows to quickly set text of a comment from a string. The string can contain paragraph breaks, this will create paragraphs of text in the comment accordingly. If you want to insert more complex elements into the comment, for example bookmarks or tables or apply rich formatting, then you need to use the appropriate node classes to build up the comment text.

  Parameters:

  text - The new text of the comment.

  Example:

  Shows how to add a comment with a reply to a document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Create new comment
  Comment newComment = new Comment(doc, "John Doe", "J.D.", new Date(System.currentTimeMillis()));
  newComment.setText("My comment.");
  
  // Add this comment to a document node
  builder.getCurrentParagraph().appendChild(newComment);
  
  Calendar cal = Calendar.getInstance();
  cal.set(2017, Calendar.SEPTEMBER, 25, 12, 15, 0);
  cal.getTime();
  
  // Add comment reply
  newComment.addReply("John Doe", "JD", cal.getTime(), "New reply");

• toString

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

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

  Parameters:

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

  Returns:

  The content of the node in the specified format.

  Example:

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

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

• toString

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

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

  Returns:

  The content of the node in the specified format.

  Parameters:

  saveFormat - A SaveFormat value.

  Example:

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

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

  Example:

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

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

  Example:

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

  Document doc = new Document();
  
  // 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));