public class Comment
A comment is an annotation which is anchored to a region of text or to a position in text. A comment can contain an arbitrary amount of block-level content.
If a
To anchor a comment to a region of text three objects are required:
Example:
Shows how to add a comment to a paragraph.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Hello world!"); Comment comment = new Comment(doc, "John Doe", "JD", new Date()); builder.getCurrentParagraph().appendChild(comment); builder.moveTo(comment.appendChild(new Paragraph(doc))); builder.write("Comment text."); Assert.assertEquals(new Date(), comment.getDateTime()); // In Microsoft Word, we can right-click this comment in the document body to edit it, or reply to it. doc.save(getArtifactsDir() + "InlineStory.AddComment.docx");
Example:
Shows how to add a comment to a document, and then reply to it.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Comment comment = new Comment(doc, "John Doe", "J.D.", new Date()); comment.setText("My comment."); // Place the comment at a node in the document's body. // This comment will show up at the location of its paragraph, // outside the right side margin of the page, and with a dotted line connecting it to its paragraph. builder.getCurrentParagraph().appendChild(comment); // Add a reply, which will show up under its parent comment. comment.addReply("Joe Bloggs", "J.B.", new Date(), "New reply"); // Comments and replies are both Comment nodes. Assert.assertEquals(2, doc.getChildNodes(NodeType.COMMENT, true).getCount()); // Comments that do not reply to other comments are "top-level", and have no ancestor. Assert.assertNull(comment.getAncestor()); // Replies have an ancestor top-level comment. Assert.assertEquals(comment, comment.getReplies().get(0).getAncestor()); doc.save(getArtifactsDir() + "Comment.AddCommentWithReply.docx");
Constructor Summary |
---|
Comment(DocumentBase doc)
Initializes a new instance of the Comment class. |
Comment(DocumentBase doc, java.lang.Stringauthor, java.lang.Stringinitial, java.util.DatedateTime)
Initializes a new instance of the Comment class. |
Property Getters/Setters Summary | ||
---|---|---|
Comment | getAncestor() | |
Returns the parent Comment object. Returns null for top-level comments.
|
||
java.lang.String | getAuthor() | |
void | setAuthor(java.lang.Stringvalue) | |
Returns or sets the author name for a comment. | ||
NodeCollection | getChildNodes() | |
Gets all immediate child nodes of this node.
|
||
int | getCount() | |
Gets the number of immediate children of this node.
|
||
int | getCustomNodeId() | |
void | setCustomNodeId(intvalue) | |
Specifies custom node identifier. | ||
java.util.Date | getDateTime() | |
void | setDateTime(java.util.Datevalue) | |
Gets the date and time that the comment was made. | ||
DocumentBase | getDocument() | |
Gets the document to which this node belongs.
|
||
boolean | getDone() | |
void | setDone(booleanvalue) | |
Gets or sets flag indicating that the comment has been marked done. | ||
Node | getFirstChild() | |
Gets the first child of the node.
|
||
Paragraph | getFirstParagraph() | |
Gets the first paragraph in the story.
|
||
Font | getFont() | |
Provides access to the font formatting of the anchor character of this object.
|
||
boolean | hasChildNodes() | |
Returns true if this node has any child nodes.
|
||
int | getId() | |
Gets the comment identifier.
|
||
java.lang.String | getInitial() | |
void | setInitial(java.lang.Stringvalue) | |
Returns or sets the initials of the user associated with a specific comment. | ||
boolean | isComposite() | |
Returns true as this node can have child nodes.
|
||
boolean | isDeleteRevision() | |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
|
||
boolean | isInsertRevision() | |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
|
||
boolean | isMoveFromRevision() | |
Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
|
||
boolean | isMoveToRevision() | |
Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
|
||
Node | getLastChild() | |
Gets the last child of the node.
|
||
Paragraph | getLastParagraph() | |
Gets the last paragraph in the story.
|
||
Node | getNextSibling() | |
Gets the node immediately following this node.
|
||
int | getNodeType() | |
Returns NodeType.Comment.
The value of the property is NodeType integer constant. |
||
ParagraphCollection | getParagraphs() | |
Gets a collection of paragraphs that are immediate children of the story.
|
||
CompositeNode | getParentNode() | |
Gets the immediate parent of this node.
|
||
Paragraph | getParentParagraph() | |
Retrieves the parent |
||
Node | getPreviousSibling() | |
Gets the node immediately preceding this node.
|
||
Range | getRange() | |
Returns a Range object that represents the portion of a document that is contained in this node.
|
||
CommentCollection | getReplies() | |
Returns a collection of |
||
int | getStoryType() | |
Returns StoryType.Comments.
The value of the property is StoryType integer constant. |
||
TableCollection | getTables() | |
Gets a collection of tables that are immediate children of the story.
|
Method Summary | ||
---|---|---|
boolean | accept(DocumentVisitor visitor) | |
Accepts a visitor.
|
||
Comment | addReply(java.lang.String author, java.lang.String initial, java.util.Date dateTime, java.lang.String text) | |
Adds a reply to this comment.
|
||
Node | appendChild(Node newChild) | |
Adds the specified node to the end of the list of child nodes for this node.
|
||
Node | deepClone(boolean isCloneChildren) | |
Creates a duplicate of the node.
|
||
void | ensureMinimum() | |
If the last child is not a paragraph, creates and appends one empty paragraph.
|
||
CompositeNode | getAncestor(int ancestorType) | |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | |
Gets the first ancestor of the specified object type.
|
||
Node | getChild(int nodeType, int index, boolean isDeep) | |
Returns an Nth child node that matches the specified type.
|
||
NodeCollection | getChildNodes(int nodeType, boolean isDeep) | |
Returns a live collection of child nodes that match the specified type.
|
||
java.lang.String | getText() | |
Gets the text of this node and of all its children.
|
||
int | indexOf(Node child) | |
Returns the index of the specified child node in the child node array.
|
||
Node | insertAfter(Node newChild, Node refChild) | |
Inserts the specified node immediately after the specified reference node.
|
||
Node | insertBefore(Node newChild, Node refChild) | |
Inserts the specified node immediately before the specified reference node.
|
||
java.util.Iterator<Node> | iterator() | |
Provides support for the for each style iteration over the child nodes of this node.
|
||
Node | nextPreOrder(Node rootNode) | |
Gets next node according to the pre-order tree traversal algorithm.
|
||
Node | prependChild(Node newChild) | |
Adds the specified node to the beginning of the list of child nodes for this node.
|
||
Node | previousPreOrder(Node rootNode) | |
Gets the previous node according to the pre-order tree traversal algorithm.
|
||
void | remove() | |
Removes itself from the parent.
|
||
void | removeAllChildren() | |
Removes all the child nodes of the current node.
|
||
void | removeAllReplies() | |
Removes all replies to this comment.
|
||
Node | removeChild(Node oldChild) | |
Removes the specified child node.
|
||
void | removeReply(Comment reply) | |
Removes the specified reply to this comment.
|
||
void | removeSmartTags() | |
Removes all |
||
NodeList | selectNodes(java.lang.String xpath) | |
Selects a list of nodes matching the XPath expression.
|
||
Node | selectSingleNode(java.lang.String xpath) | |
Selects the first Node that matches the XPath expression.
|
||
void | setText(java.lang.String text) | |
This is a convenience method that allows to easily set text of the comment.
|
||
java.lang.String | toString(SaveOptions saveOptions) | |
Exports the content of the node into a string using the specified save options.
|
||
java.lang.String | toString(int saveFormat) | |
Exports the content of the node into a string in the specified format.
|
public Comment(DocumentBase doc) throws java.lang.Exception
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
doc
- The owner document.Example:
Shows how print the contents of all comments and their comment ranges using a document visitor.public void createCommentsAndPrintAllInfo() throws Exception { Document doc = new Document(); Comment newComment = new Comment(doc); { newComment.setAuthor("VDeryushev"); newComment.setInitial("VD"); newComment.setDateTime(new Date()); } newComment.setText("Comment regarding text."); // Add text to the document, warp it in a comment range, and then add your comment. Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new CommentRangeStart(doc, newComment.getId())); para.appendChild(new Run(doc, "Commented text.")); para.appendChild(new CommentRangeEnd(doc, newComment.getId())); para.appendChild(newComment); // Add two replies to the comment. newComment.addReply("John Doe", "JD", new Date(), "New reply."); newComment.addReply("John Doe", "JD", new Date(), "Another reply."); printAllCommentInfo(doc.getChildNodes(NodeType.COMMENT, true)); } /// <summary> /// Iterates over every top-level comment and prints its comment range, contents, and replies. /// </summary> private static void printAllCommentInfo(NodeCollection comments) throws Exception { CommentInfoPrinter commentVisitor = new CommentInfoPrinter(); // Iterate over all top level comments. Unlike reply-type comments, top-level comments have no ancestor. for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { // First, visit the start of the comment range. CommentRangeStart commentRangeStart = (CommentRangeStart) comment.getPreviousSibling().getPreviousSibling().getPreviousSibling(); commentRangeStart.accept(commentVisitor); // Then, visit the comment, and any replies that it may have. comment.accept(commentVisitor); for (Comment reply : comment.getReplies()) reply.accept(commentVisitor); // Finally, visit the end of the comment range, and then print the visitor's text contents. CommentRangeEnd commentRangeEnd = (CommentRangeEnd) comment.getPreviousSibling(); commentRangeEnd.accept(commentVisitor); System.out.println(commentVisitor.getText()); } } } /// <summary> /// Prints information and contents of all 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 final StringBuilder mBuilder; }
public Comment(DocumentBase doc, java.lang.String author, java.lang.String initial, java.util.Date dateTime) throws java.lang.Exception
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.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Hello world!"); Comment comment = new Comment(doc, "John Doe", "JD", new Date()); builder.getCurrentParagraph().appendChild(comment); builder.moveTo(comment.appendChild(new Paragraph(doc))); builder.write("Comment text."); Assert.assertEquals(new Date(), comment.getDateTime()); // In Microsoft Word, we can right-click this comment in the document body to edit it, or reply to it. doc.save(getArtifactsDir() + "InlineStory.AddComment.docx");
public Comment getAncestor()
Example:
Shows how to print all of a document's comments and their replies.Document doc = new Document(getMyDir() + "Comments.docx"); NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true); // If a comment has no ancestor, it is a "top-level" comment as opposed to a reply-type comment. // Print all top-level comments along with their replies, if there are any. for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { System.out.println("Top-level comment:"); System.out.println("\t\"{comment.GetText().Trim()}\", by {comment.Author}"); System.out.println("Has {comment.Replies.Count} replies"); for (Comment commentReply : comment.getReplies()) { System.out.println("\t\"{commentReply.GetText().Trim()}\", by {commentReply.Author}"); } System.out.println(); } }
public java.lang.String getAuthor() / public void setAuthor(java.lang.String value)
Cannot be null.
Default is empty string.
Example:
Shows how to print all of a document's comments and their replies.Document doc = new Document(getMyDir() + "Comments.docx"); NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true); // If a comment has no ancestor, it is a "top-level" comment as opposed to a reply-type comment. // Print all top-level comments along with their replies, if there are any. for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { System.out.println("Top-level comment:"); System.out.println("\t\"{comment.GetText().Trim()}\", by {comment.Author}"); System.out.println("Has {comment.Replies.Count} replies"); for (Comment commentReply : comment.getReplies()) { System.out.println("\t\"{commentReply.GetText().Trim()}\", by {commentReply.Author}"); } System.out.println(); } }
public NodeCollection getChildNodes()
Note, 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 traverse through a composite node's collection of child nodes.Document doc = new Document(); // Add two runs and one shape as child nodes to the first paragraph of this document. Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true); paragraph.appendChild(new Run(doc, "Hello world! ")); Shape shape = new Shape(doc, ShapeType.RECTANGLE); shape.setWidth(200.0); shape.setHeight(200.0); shape.setWrapType(WrapType.INLINE); paragraph.appendChild(shape); paragraph.appendChild(new Run(doc, "Hello again!")); // Iterate through the paragraph's collection of immediate children, // and print any runs or shapes that we find within. NodeCollection children = paragraph.getChildNodes(); Assert.assertEquals(3, paragraph.getChildNodes().getCount()); for (Node child : (Iterable<Node>) children) switch (child.getNodeType()) { case NodeType.RUN: System.out.println("Run contents:"); System.out.println("\t\"{child.GetText().Trim()}\""); break; case NodeType.SHAPE: Shape childShape = (Shape) child; System.out.println("Shape:"); System.out.println("\t{childShape.ShapeType}, {childShape.Width}x{childShape.Height}"); break; }
public int getCount()
Example:
Shows how to add, update and delete child nodes in a CompositeNode's collection of children.Document doc = new Document(); // An empty document, by default, has one paragraph. Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount()); // Composite nodes such as our paragraph can contain other composite and inline nodes as children. Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // Create three more run nodes. Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // The document body will not display these runs until we insert them into a composite node // that itself is a part of the document's node tree, as we did with the first run. // We can determine where the text contents of nodes that we insert // appears in the document by specifying an insertion location relative to another node in the paragraph. Assert.assertEquals("Initial text.", paragraph.getText().trim()); // Insert the second run into the paragraph in front of the initial run. paragraph.insertBefore(run2, paragraphText); Assert.assertEquals("Run 2. Initial text.", paragraph.getText().trim()); // Insert the third run after the initial run. paragraph.insertAfter(run3, paragraphText); Assert.assertEquals("Run 2. Initial text. Run 3.", paragraph.getText().trim()); // Insert the first run to the start of the paragraph's child nodes collection. 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()); // We can modify the contents of the run by editing and deleting existing child nodes. ((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());
public int getCustomNodeId() / public void setCustomNodeId(int value)
Default is zero.
This identifier can be set and used arbitrarily. For example, as a key to get external data.
public java.util.Date getDateTime() / public void setDateTime(java.util.Date value)
Default is 03.01.0001.
Example:
Shows how print the contents of all comments and their comment ranges using a document visitor.public void createCommentsAndPrintAllInfo() throws Exception { Document doc = new Document(); Comment newComment = new Comment(doc); { newComment.setAuthor("VDeryushev"); newComment.setInitial("VD"); newComment.setDateTime(new Date()); } newComment.setText("Comment regarding text."); // Add text to the document, warp it in a comment range, and then add your comment. Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new CommentRangeStart(doc, newComment.getId())); para.appendChild(new Run(doc, "Commented text.")); para.appendChild(new CommentRangeEnd(doc, newComment.getId())); para.appendChild(newComment); // Add two replies to the comment. newComment.addReply("John Doe", "JD", new Date(), "New reply."); newComment.addReply("John Doe", "JD", new Date(), "Another reply."); printAllCommentInfo(doc.getChildNodes(NodeType.COMMENT, true)); } /// <summary> /// Iterates over every top-level comment and prints its comment range, contents, and replies. /// </summary> private static void printAllCommentInfo(NodeCollection comments) throws Exception { CommentInfoPrinter commentVisitor = new CommentInfoPrinter(); // Iterate over all top level comments. Unlike reply-type comments, top-level comments have no ancestor. for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { // First, visit the start of the comment range. CommentRangeStart commentRangeStart = (CommentRangeStart) comment.getPreviousSibling().getPreviousSibling().getPreviousSibling(); commentRangeStart.accept(commentVisitor); // Then, visit the comment, and any replies that it may have. comment.accept(commentVisitor); for (Comment reply : comment.getReplies()) reply.accept(commentVisitor); // Finally, visit the end of the comment range, and then print the visitor's text contents. CommentRangeEnd commentRangeEnd = (CommentRangeEnd) comment.getPreviousSibling(); commentRangeEnd.accept(commentVisitor); System.out.println(commentVisitor.getText()); } } } /// <summary> /// Prints information and contents of all 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 final StringBuilder mBuilder; }
public DocumentBase getDocument()
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.Document doc = new Document(); Paragraph para = new Paragraph(doc); para.appendChild(new Run(doc, "Hello world!")); // We have not yet appended this paragraph as a child to any composite node. Assert.assertNull(para.getParentNode()); // If a node is an appropriate child node type of another composite node, // we can attach it as a child only if both nodes have the same owner document. // The owner document is the document we passed to the node's constructor. // We have not attached this paragraph to the document, so the document does not contain its text. Assert.assertEquals(para.getDocument(), doc); Assert.assertEquals("", doc.getText().trim()); // Since the document owns this paragraph, we can apply one of its styles to the paragraph's contents. para.getParagraphFormat().setStyleName("Heading 1"); // Add this node to the document, and then verify its contents. doc.getFirstSection().getBody().appendChild(para); Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode()); Assert.assertEquals("Hello world!", doc.getText().trim());
public boolean getDone() / public void setDone(boolean value)
Example:
Shows how to mark a comment as "done".Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Helo world!"); // Insert a comment to point out an error. Comment comment = new Comment(doc, "John Doe", "J.D.", new Date()); comment.setText("Fix the spelling error!"); doc.getFirstSection().getBody().getFirstParagraph().appendChild(comment); // Comments have a "Done" flag, which by default, is false. // If a comment suggests that a we make a change within the document, // we can apply the change, and then also use that flag to indicate the correction. Assert.assertFalse(comment.getDone()); doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(0).setText("Hello world!"); comment.setDone(true); // Comments that are "done" will differentiate themselves // from ones that are not "done" with a faded text color. comment = new Comment(doc, "John Doe", "J.D.", new Date()); comment.setText("Add text to this paragraph."); builder.getCurrentParagraph().appendChild(comment); doc.save(getArtifactsDir() + "Comment.Done.docx");
Example:
Shows how print the contents of all comments and their comment ranges using a document visitor.public void createCommentsAndPrintAllInfo() throws Exception { Document doc = new Document(); Comment newComment = new Comment(doc); { newComment.setAuthor("VDeryushev"); newComment.setInitial("VD"); newComment.setDateTime(new Date()); } newComment.setText("Comment regarding text."); // Add text to the document, warp it in a comment range, and then add your comment. Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new CommentRangeStart(doc, newComment.getId())); para.appendChild(new Run(doc, "Commented text.")); para.appendChild(new CommentRangeEnd(doc, newComment.getId())); para.appendChild(newComment); // Add two replies to the comment. newComment.addReply("John Doe", "JD", new Date(), "New reply."); newComment.addReply("John Doe", "JD", new Date(), "Another reply."); printAllCommentInfo(doc.getChildNodes(NodeType.COMMENT, true)); } /// <summary> /// Iterates over every top-level comment and prints its comment range, contents, and replies. /// </summary> private static void printAllCommentInfo(NodeCollection comments) throws Exception { CommentInfoPrinter commentVisitor = new CommentInfoPrinter(); // Iterate over all top level comments. Unlike reply-type comments, top-level comments have no ancestor. for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { // First, visit the start of the comment range. CommentRangeStart commentRangeStart = (CommentRangeStart) comment.getPreviousSibling().getPreviousSibling().getPreviousSibling(); commentRangeStart.accept(commentVisitor); // Then, visit the comment, and any replies that it may have. comment.accept(commentVisitor); for (Comment reply : comment.getReplies()) reply.accept(commentVisitor); // Finally, visit the end of the comment range, and then print the visitor's text contents. CommentRangeEnd commentRangeEnd = (CommentRangeEnd) comment.getPreviousSibling(); commentRangeEnd.accept(commentVisitor); System.out.println(commentVisitor.getText()); } } } /// <summary> /// Prints information and contents of all 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 final StringBuilder mBuilder; }
public Node getFirstChild()
Example:
Shows how to use a node's NextSibling property to enumerate through its immediate children.Document doc = new Document(getMyDir() + "Paragraphs.docx"); for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) { System.out.println(Node.nodeTypeToString(node.getNodeType())); }
Example:
Shows how to traverse a composite node's tree of child nodes.public void recurseChildren() 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) { 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. Otherwise, print its contents if it is an inline 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(); } } }
public Paragraph getFirstParagraph()
Example:
Shows how to add a comment to a paragraph.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Hello world!"); Comment comment = new Comment(doc, "John Doe", "JD", new Date()); builder.getCurrentParagraph().appendChild(comment); builder.moveTo(comment.appendChild(new Paragraph(doc))); builder.write("Comment text."); Assert.assertEquals(new Date(), comment.getDateTime()); // In Microsoft Word, we can right-click this comment in the document body to edit it, or reply to it. doc.save(getArtifactsDir() + "InlineStory.AddComment.docx");
Example:
Shows how to insert and customize footnotes.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Add text, and reference it with a footnote. This footnote will place a small superscript reference // mark after the text that it references and create an entry below the main body text at the bottom of the page. // This entry will contain the footnote's reference mark and the reference text, // which we will pass to the document builder's "InsertFootnote" method. builder.write("Main body text."); Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text."); // If this property is set to "true", then our footnote's reference mark // will be its index among all of the section's footnotes. // This is the first footnote, so the reference mark will be "1". Assert.assertTrue(footnote.isAuto()); // We can move the document builder inside the footnote to edit its reference text. 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."); // We can set a custom reference mark which the footnote will use instead of its index number. footnote.setReferenceMark("RefMark"); Assert.assertFalse(footnote.isAuto()); // A bookmark with the "IsAuto" flag set to true will still show its real index // even if previous bookmarks display custom reference marks, so this bookmark's reference mark will be a "3". builder.write(" More main body text."); footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text."); Assert.assertTrue(footnote.isAuto()); doc.save(getArtifactsDir() + "InlineStory.AddFootnote.docx");
public Font getFont()
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 referencing page's footer. 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, // for us to be able to 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 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(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph()); // 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 to 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");
public boolean hasChildNodes()
Example:
Shows how to combine the rows from two tables into one.// Load the document Document doc = new Document(getMyDir() + "Tables.docx"); // Get the first and second table in the document // The rows from the second table will be appended to the end of the first table Table firstTable = (Table) doc.getChild(NodeType.TABLE, 0, true); Table secondTable = (Table) doc.getChild(NodeType.TABLE, 1, true); // Append all rows from the current table to the next // Due to the design of tables even tables with different cell count and widths can be joined into one table while (secondTable.hasChildNodes()) firstTable.getRows().add(secondTable.getFirstRow()); // Remove the empty table container secondTable.remove(); doc.save(getArtifactsDir() + "Table.CombineTables.docx");
public int getId()
The comment identifier allows to anchor a comment to a region of text in the document.
The region must be demarcated using the
You would use this value when looking for the
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 print the contents of all comments and their comment ranges using a document visitor.public void createCommentsAndPrintAllInfo() throws Exception { Document doc = new Document(); Comment newComment = new Comment(doc); { newComment.setAuthor("VDeryushev"); newComment.setInitial("VD"); newComment.setDateTime(new Date()); } newComment.setText("Comment regarding text."); // Add text to the document, warp it in a comment range, and then add your comment. Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new CommentRangeStart(doc, newComment.getId())); para.appendChild(new Run(doc, "Commented text.")); para.appendChild(new CommentRangeEnd(doc, newComment.getId())); para.appendChild(newComment); // Add two replies to the comment. newComment.addReply("John Doe", "JD", new Date(), "New reply."); newComment.addReply("John Doe", "JD", new Date(), "Another reply."); printAllCommentInfo(doc.getChildNodes(NodeType.COMMENT, true)); } /// <summary> /// Iterates over every top-level comment and prints its comment range, contents, and replies. /// </summary> private static void printAllCommentInfo(NodeCollection comments) throws Exception { CommentInfoPrinter commentVisitor = new CommentInfoPrinter(); // Iterate over all top level comments. Unlike reply-type comments, top-level comments have no ancestor. for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { // First, visit the start of the comment range. CommentRangeStart commentRangeStart = (CommentRangeStart) comment.getPreviousSibling().getPreviousSibling().getPreviousSibling(); commentRangeStart.accept(commentVisitor); // Then, visit the comment, and any replies that it may have. comment.accept(commentVisitor); for (Comment reply : comment.getReplies()) reply.accept(commentVisitor); // Finally, visit the end of the comment range, and then print the visitor's text contents. CommentRangeEnd commentRangeEnd = (CommentRangeEnd) comment.getPreviousSibling(); commentRangeEnd.accept(commentVisitor); System.out.println(commentVisitor.getText()); } } } /// <summary> /// Prints information and contents of all 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 final StringBuilder mBuilder; }
public java.lang.String getInitial() / public void setInitial(java.lang.String value)
Cannot be null.
Default is empty string.
Example:
Shows how print the contents of all comments and their comment ranges using a document visitor.public void createCommentsAndPrintAllInfo() throws Exception { Document doc = new Document(); Comment newComment = new Comment(doc); { newComment.setAuthor("VDeryushev"); newComment.setInitial("VD"); newComment.setDateTime(new Date()); } newComment.setText("Comment regarding text."); // Add text to the document, warp it in a comment range, and then add your comment. Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new CommentRangeStart(doc, newComment.getId())); para.appendChild(new Run(doc, "Commented text.")); para.appendChild(new CommentRangeEnd(doc, newComment.getId())); para.appendChild(newComment); // Add two replies to the comment. newComment.addReply("John Doe", "JD", new Date(), "New reply."); newComment.addReply("John Doe", "JD", new Date(), "Another reply."); printAllCommentInfo(doc.getChildNodes(NodeType.COMMENT, true)); } /// <summary> /// Iterates over every top-level comment and prints its comment range, contents, and replies. /// </summary> private static void printAllCommentInfo(NodeCollection comments) throws Exception { CommentInfoPrinter commentVisitor = new CommentInfoPrinter(); // Iterate over all top level comments. Unlike reply-type comments, top-level comments have no ancestor. for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { // First, visit the start of the comment range. CommentRangeStart commentRangeStart = (CommentRangeStart) comment.getPreviousSibling().getPreviousSibling().getPreviousSibling(); commentRangeStart.accept(commentVisitor); // Then, visit the comment, and any replies that it may have. comment.accept(commentVisitor); for (Comment reply : comment.getReplies()) reply.accept(commentVisitor); // Finally, visit the end of the comment range, and then print the visitor's text contents. CommentRangeEnd commentRangeEnd = (CommentRangeEnd) comment.getPreviousSibling(); commentRangeEnd.accept(commentVisitor); System.out.println(commentVisitor.getText()); } } } /// <summary> /// Prints information and contents of all 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 final StringBuilder mBuilder; }
public boolean isComposite()
Example:
Shows how to traverse a composite node's tree of child nodes.public void recurseChildren() 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) { 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. Otherwise, print its contents if it is an inline 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(); } } }
public boolean isDeleteRevision()
Example:
Shows how to view revision-related properties of InlineStory nodes.Document doc = new Document(getMyDir() + "Revision footnotes.docx"); // When we edit the document while the "Track Changes" option, found in via Review -> Tracking, // is turned on in Microsoft Word, the changes we apply count as revisions. // When editing a document using Aspose.Words, we can begin tracking revisions by // invoking the document's "StartTrackRevisions" method, and stop tracking by using the "StopTrackRevisions" method. // We can either accept revisions to assimilate them into the document // or reject them to undo and discard the proposed change. Assert.assertTrue(doc.hasRevisions()); NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true); Assert.assertEquals(5, footnotes.getCount()); // Below are five types of revisions that can flag an InlineStory node. // 1 - An "insert" revision: // This revision occurs when we insert text while tracking changes. Footnote footnote = (Footnote) footnotes.get(2); Assert.assertTrue(footnote.isInsertRevision()); // 2 - A "move from" revision: // When we highlight text in Microsoft Word, and then drag it to a different place in the document // while tracking changes, two revisions appear. // The "move from" revision is a copy of the text originally before we moved it. footnote = (Footnote) footnotes.get(4); Assert.assertTrue(footnote.isMoveFromRevision()); // 3 - A "move to" revision: // The "move to" revision is the text that we moved in its new position in the document. // "Move from" and "move to" revisions appear in pairs for every move revision we carry out. // Accepting a move revision deletes the "move from" revision and its text, // and keeps the text from the "move to" revision. // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision. footnote = (Footnote) footnotes.get(1); Assert.assertTrue(footnote.isMoveToRevision()); // 4 - A "delete" revision: // This revision occurs when we delete text while tracking changes. When we delete text like this, // it will stay in the document as a revision until we either accept the revision, // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was. footnote = (Footnote) footnotes.get(3); Assert.assertTrue(footnote.isDeleteRevision());
public boolean isInsertRevision()
Example:
Shows how to view revision-related properties of InlineStory nodes.Document doc = new Document(getMyDir() + "Revision footnotes.docx"); // When we edit the document while the "Track Changes" option, found in via Review -> Tracking, // is turned on in Microsoft Word, the changes we apply count as revisions. // When editing a document using Aspose.Words, we can begin tracking revisions by // invoking the document's "StartTrackRevisions" method, and stop tracking by using the "StopTrackRevisions" method. // We can either accept revisions to assimilate them into the document // or reject them to undo and discard the proposed change. Assert.assertTrue(doc.hasRevisions()); NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true); Assert.assertEquals(5, footnotes.getCount()); // Below are five types of revisions that can flag an InlineStory node. // 1 - An "insert" revision: // This revision occurs when we insert text while tracking changes. Footnote footnote = (Footnote) footnotes.get(2); Assert.assertTrue(footnote.isInsertRevision()); // 2 - A "move from" revision: // When we highlight text in Microsoft Word, and then drag it to a different place in the document // while tracking changes, two revisions appear. // The "move from" revision is a copy of the text originally before we moved it. footnote = (Footnote) footnotes.get(4); Assert.assertTrue(footnote.isMoveFromRevision()); // 3 - A "move to" revision: // The "move to" revision is the text that we moved in its new position in the document. // "Move from" and "move to" revisions appear in pairs for every move revision we carry out. // Accepting a move revision deletes the "move from" revision and its text, // and keeps the text from the "move to" revision. // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision. footnote = (Footnote) footnotes.get(1); Assert.assertTrue(footnote.isMoveToRevision()); // 4 - A "delete" revision: // This revision occurs when we delete text while tracking changes. When we delete text like this, // it will stay in the document as a revision until we either accept the revision, // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was. footnote = (Footnote) footnotes.get(3); Assert.assertTrue(footnote.isDeleteRevision());
public boolean isMoveFromRevision()
Example:
Shows how to view revision-related properties of InlineStory nodes.Document doc = new Document(getMyDir() + "Revision footnotes.docx"); // When we edit the document while the "Track Changes" option, found in via Review -> Tracking, // is turned on in Microsoft Word, the changes we apply count as revisions. // When editing a document using Aspose.Words, we can begin tracking revisions by // invoking the document's "StartTrackRevisions" method, and stop tracking by using the "StopTrackRevisions" method. // We can either accept revisions to assimilate them into the document // or reject them to undo and discard the proposed change. Assert.assertTrue(doc.hasRevisions()); NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true); Assert.assertEquals(5, footnotes.getCount()); // Below are five types of revisions that can flag an InlineStory node. // 1 - An "insert" revision: // This revision occurs when we insert text while tracking changes. Footnote footnote = (Footnote) footnotes.get(2); Assert.assertTrue(footnote.isInsertRevision()); // 2 - A "move from" revision: // When we highlight text in Microsoft Word, and then drag it to a different place in the document // while tracking changes, two revisions appear. // The "move from" revision is a copy of the text originally before we moved it. footnote = (Footnote) footnotes.get(4); Assert.assertTrue(footnote.isMoveFromRevision()); // 3 - A "move to" revision: // The "move to" revision is the text that we moved in its new position in the document. // "Move from" and "move to" revisions appear in pairs for every move revision we carry out. // Accepting a move revision deletes the "move from" revision and its text, // and keeps the text from the "move to" revision. // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision. footnote = (Footnote) footnotes.get(1); Assert.assertTrue(footnote.isMoveToRevision()); // 4 - A "delete" revision: // This revision occurs when we delete text while tracking changes. When we delete text like this, // it will stay in the document as a revision until we either accept the revision, // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was. footnote = (Footnote) footnotes.get(3); Assert.assertTrue(footnote.isDeleteRevision());
public boolean isMoveToRevision()
Example:
Shows how to view revision-related properties of InlineStory nodes.Document doc = new Document(getMyDir() + "Revision footnotes.docx"); // When we edit the document while the "Track Changes" option, found in via Review -> Tracking, // is turned on in Microsoft Word, the changes we apply count as revisions. // When editing a document using Aspose.Words, we can begin tracking revisions by // invoking the document's "StartTrackRevisions" method, and stop tracking by using the "StopTrackRevisions" method. // We can either accept revisions to assimilate them into the document // or reject them to undo and discard the proposed change. Assert.assertTrue(doc.hasRevisions()); NodeCollection footnotes = doc.getChildNodes(NodeType.FOOTNOTE, true); Assert.assertEquals(5, footnotes.getCount()); // Below are five types of revisions that can flag an InlineStory node. // 1 - An "insert" revision: // This revision occurs when we insert text while tracking changes. Footnote footnote = (Footnote) footnotes.get(2); Assert.assertTrue(footnote.isInsertRevision()); // 2 - A "move from" revision: // When we highlight text in Microsoft Word, and then drag it to a different place in the document // while tracking changes, two revisions appear. // The "move from" revision is a copy of the text originally before we moved it. footnote = (Footnote) footnotes.get(4); Assert.assertTrue(footnote.isMoveFromRevision()); // 3 - A "move to" revision: // The "move to" revision is the text that we moved in its new position in the document. // "Move from" and "move to" revisions appear in pairs for every move revision we carry out. // Accepting a move revision deletes the "move from" revision and its text, // and keeps the text from the "move to" revision. // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision. footnote = (Footnote) footnotes.get(1); Assert.assertTrue(footnote.isMoveToRevision()); // 4 - A "delete" revision: // This revision occurs when we delete text while tracking changes. When we delete text like this, // it will stay in the document as a revision until we either accept the revision, // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was. footnote = (Footnote) footnotes.get(3); Assert.assertTrue(footnote.isDeleteRevision());
public Node getLastChild()
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); 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());
public Paragraph getLastParagraph()
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 referencing page's footer. 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, // for us to be able to 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 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(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph()); // 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 to 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");
public Node getNextSibling()
Example:
Shows how to use a node's NextSibling property to enumerate through its immediate children.Document doc = new Document(getMyDir() + "Paragraphs.docx"); for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) { System.out.println(Node.nodeTypeToString(node.getNodeType())); }
Example:
Shows how to traverse a composite node's tree of child nodes.public void recurseChildren() 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) { 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. Otherwise, print its contents if it is an inline 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(); } } }
public int getNodeType()
Example:
Shows how to traverse a composite node's tree of child nodes.public void recurseChildren() 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) { 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. Otherwise, print its contents if it is an inline 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(); } } }
public ParagraphCollection getParagraphs()
Example:
Shows how to add a comment to a paragraph.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Hello world!"); Comment comment = new Comment(doc, "John Doe", "JD", new Date()); builder.getCurrentParagraph().appendChild(comment); builder.moveTo(comment.appendChild(new Paragraph(doc))); builder.write("Comment text."); Assert.assertEquals(new Date(), comment.getDateTime()); // In Microsoft Word, we can right-click this comment in the document body to edit it, or reply to it. doc.save(getArtifactsDir() + "InlineStory.AddComment.docx");
Example:
Shows how to insert and customize footnotes.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Add text, and reference it with a footnote. This footnote will place a small superscript reference // mark after the text that it references and create an entry below the main body text at the bottom of the page. // This entry will contain the footnote's reference mark and the reference text, // which we will pass to the document builder's "InsertFootnote" method. builder.write("Main body text."); Footnote footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text."); // If this property is set to "true", then our footnote's reference mark // will be its index among all of the section's footnotes. // This is the first footnote, so the reference mark will be "1". Assert.assertTrue(footnote.isAuto()); // We can move the document builder inside the footnote to edit its reference text. 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."); // We can set a custom reference mark which the footnote will use instead of its index number. footnote.setReferenceMark("RefMark"); Assert.assertFalse(footnote.isAuto()); // A bookmark with the "IsAuto" flag set to true will still show its real index // even if previous bookmarks display custom reference marks, so this bookmark's reference mark will be a "3". builder.write(" More main body text."); footnote = builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text."); Assert.assertTrue(footnote.isAuto()); doc.save(getArtifactsDir() + "InlineStory.AddFootnote.docx");
public CompositeNode getParentNode()
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 a node's parent node.Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); // Append a child Run node to the document's first paragraph. Run run = new Run(doc, "Hello world!"); para.appendChild(run); // The paragraph is the parent node of the run node. We can trace this lineage // all the way to the document node, which is the root of the document's node tree. 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.Document doc = new Document(); Paragraph para = new Paragraph(doc); para.appendChild(new Run(doc, "Hello world!")); // We have not yet appended this paragraph as a child to any composite node. Assert.assertNull(para.getParentNode()); // If a node is an appropriate child node type of another composite node, // we can attach it as a child only if both nodes have the same owner document. // The owner document is the document we passed to the node's constructor. // We have not attached this paragraph to the document, so the document does not contain its text. Assert.assertEquals(para.getDocument(), doc); Assert.assertEquals("", doc.getText().trim()); // Since the document owns this paragraph, we can apply one of its styles to the paragraph's contents. para.getParagraphFormat().setStyleName("Heading 1"); // Add this node to the document, and then verify its contents. doc.getFirstSection().getBody().appendChild(para); Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode()); Assert.assertEquals("Hello world!", doc.getText().trim());
public Paragraph getParentParagraph()
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 referencing page's footer. 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, // for us to be able to 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 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(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph()); // 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 to 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");
public Node getPreviousSibling()
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); 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());
public Range getRange()
Example:
Shows how to delete all the nodes from a range.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Add text to the first section in the document, and then add another section. builder.write("Section 1. "); builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS); builder.write("Section 2."); Assert.assertEquals("Section 1. \fSection 2.", doc.getText().trim()); // Remove the first section entirely by removing all of the nodes // within its range, including the section itself. doc.getSections().get(0).getRange().delete(); Assert.assertEquals(1, doc.getSections().getCount()); Assert.assertEquals("Section 2.", doc.getText().trim());
public CommentCollection getReplies()
Example:
Shows how to print all of a document's comments and their replies.Document doc = new Document(getMyDir() + "Comments.docx"); NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true); // If a comment has no ancestor, it is a "top-level" comment as opposed to a reply-type comment. // Print all top-level comments along with their replies, if there are any. for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { System.out.println("Top-level comment:"); System.out.println("\t\"{comment.GetText().Trim()}\", by {comment.Author}"); System.out.println("Has {comment.Replies.Count} replies"); for (Comment commentReply : comment.getReplies()) { System.out.println("\t\"{commentReply.GetText().Trim()}\", by {commentReply.Author}"); } System.out.println(); } }
public int getStoryType()
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 referencing page's footer. 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, // for us to be able to 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 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(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph()); // 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 to 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");
public TableCollection getTables()
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 referencing page's footer. 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, // for us to be able to 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 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(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph()); // 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 to 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");
public boolean accept(DocumentVisitor visitor) throws java.lang.Exception
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.
visitor
- The visitor that will visit the nodes.Example:
Shows how print the contents of all comments and their comment ranges using a document visitor.public void createCommentsAndPrintAllInfo() throws Exception { Document doc = new Document(); Comment newComment = new Comment(doc); { newComment.setAuthor("VDeryushev"); newComment.setInitial("VD"); newComment.setDateTime(new Date()); } newComment.setText("Comment regarding text."); // Add text to the document, warp it in a comment range, and then add your comment. Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new CommentRangeStart(doc, newComment.getId())); para.appendChild(new Run(doc, "Commented text.")); para.appendChild(new CommentRangeEnd(doc, newComment.getId())); para.appendChild(newComment); // Add two replies to the comment. newComment.addReply("John Doe", "JD", new Date(), "New reply."); newComment.addReply("John Doe", "JD", new Date(), "Another reply."); printAllCommentInfo(doc.getChildNodes(NodeType.COMMENT, true)); } /// <summary> /// Iterates over every top-level comment and prints its comment range, contents, and replies. /// </summary> private static void printAllCommentInfo(NodeCollection comments) throws Exception { CommentInfoPrinter commentVisitor = new CommentInfoPrinter(); // Iterate over all top level comments. Unlike reply-type comments, top-level comments have no ancestor. for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { // First, visit the start of the comment range. CommentRangeStart commentRangeStart = (CommentRangeStart) comment.getPreviousSibling().getPreviousSibling().getPreviousSibling(); commentRangeStart.accept(commentVisitor); // Then, visit the comment, and any replies that it may have. comment.accept(commentVisitor); for (Comment reply : comment.getReplies()) reply.accept(commentVisitor); // Finally, visit the end of the comment range, and then print the visitor's text contents. CommentRangeEnd commentRangeEnd = (CommentRangeEnd) comment.getPreviousSibling(); commentRangeEnd.accept(commentVisitor); System.out.println(commentVisitor.getText()); } } } /// <summary> /// Prints information and contents of all 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 final StringBuilder mBuilder; }
public Comment addReply(java.lang.String author, java.lang.String initial, java.util.Date dateTime, java.lang.String text) throws java.lang.Exception
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.Example:
Shows how to add a comment to a document, and then reply to it.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Comment comment = new Comment(doc, "John Doe", "J.D.", new Date()); comment.setText("My comment."); // Place the comment at a node in the document's body. // This comment will show up at the location of its paragraph, // outside the right side margin of the page, and with a dotted line connecting it to its paragraph. builder.getCurrentParagraph().appendChild(comment); // Add a reply, which will show up under its parent comment. comment.addReply("Joe Bloggs", "J.B.", new Date(), "New reply"); // Comments and replies are both Comment nodes. Assert.assertEquals(2, doc.getChildNodes(NodeType.COMMENT, true).getCount()); // Comments that do not reply to other comments are "top-level", and have no ancestor. Assert.assertNull(comment.getAncestor()); // Replies have an ancestor top-level comment. Assert.assertEquals(comment, comment.getReplies().get(0).getAncestor()); doc.save(getArtifactsDir() + "Comment.AddCommentWithReply.docx");
public Node appendChild(Node newChild) throws java.lang.Exception
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
newChild
- The node to add.Example:
Shows how to construct an Aspose.Words document by hand.Document doc = new Document(); // A blank document contains one section, one body and one paragraph. // Call the "RemoveAllChildren" method to remove all those nodes, // and end up with a document node with no children. doc.removeAllChildren(); // This document now has no composite child nodes that we can add content to. // If we wish to edit it, we will need to repopulate its node collection. // First, create a new section, and then append it as a child to the root document node. Section section = new Section(doc); doc.appendChild(section); // Set some page setup properties for the section. section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE); section.getPageSetup().setPaperSize(PaperSize.LETTER); // A section needs a body, which will contain and display all of its contents // on the page between the section's header and footer. Body body = new Body(doc); section.appendChild(body); // Create a paragraph, set some formatting properties, and then append it as a child to the body. Paragraph para = new Paragraph(doc); para.getParagraphFormat().setStyleName("Heading 1"); para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); body.appendChild(para); // Finally, add some content to do the document by creating a run, // setting its text contents and appearance, and appending it as a child to the paragraph. Run run = new Run(doc); run.setText("Hello World!"); run.getFont().setColor(Color.RED); para.appendChild(run); Assert.assertEquals("Hello World!", doc.getText().trim()); doc.save(getArtifactsDir() + "Section.CreateManually.docx");
public Node deepClone(boolean isCloneChildren)
This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.
This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.Example:
Shows how to clone a composite node.Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new Run(doc, "Hello world!")); // Below are two ways of cloning a composite node. // 1 - Create a clone of a node, and create a clone of each of its child nodes as well. Node cloneWithChildren = para.deepClone(true); Assert.assertTrue(((CompositeNode) cloneWithChildren).hasChildNodes()); Assert.assertEquals("Hello world!", cloneWithChildren.getText().trim()); // 2 - Create a clone of a node just by itself without any children. Node cloneWithoutChildren = para.deepClone(false); Assert.assertFalse(((CompositeNode) cloneWithoutChildren).hasChildNodes()); Assert.assertEquals("", cloneWithoutChildren.getText().trim());
public void ensureMinimum() throws java.lang.Exception
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 referencing page's footer. 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, // for us to be able to 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 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(doc.getFirstSection().getBody().getFirstParagraph(), comment.getParentParagraph()); // 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 to 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");
public CompositeNode getAncestor(int ancestorType)
ancestorType
- A Example:
Shows how to find out if a table contains another table or if the table itself is nested inside another table.public void calculateDepthOfNestedTables() throws Exception { Document doc = new Document(getMyDir() + "Nested tables.docx"); NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true); for (int i = 0; i < tables.getCount(); i++) { // First lets find if any cells in the table have tables themselves as children int count = getChildTableCount((Table) tables.get(i)); System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count)); // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth int tableDepth = getNestedDepthOfTable((Table) tables.get(i)); if (tableDepth > 0) System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth)); else System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i)); } } /** * Calculates what level a table is nested inside other tables. * * @returns An integer containing the level the table is nested at. * 0 = Table is not nested inside any other table * 1 = Table is nested within one parent table * 2 = Table is nested within two parent tables etc.. */ private static int getNestedDepthOfTable(final Table table) { int depth = 0; int type = table.getNodeType(); // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table Node parent = table.getAncestor(table.getNodeType()); while (parent != null) { // Every time we find a table a level up we increase the depth counter and then try to find an // ancestor of type table from the parent depth++; parent = parent.getAncestor(Table.class); } return depth; } /** * Determines if a table contains any immediate child table within its cells. * Does not recursively traverse through those tables to check for further tables. * * @returns Returns true if at least one child cell contains a table. * Returns false if no cells in the table contains a table. */ private static int getChildTableCount(final Table table) { int tableCount = 0; // Iterate through all child rows in the table for (Row row : table.getRows()) { // Iterate through all child cells in the row for (Cell cell : row.getCells()) { // Retrieve the collection of child tables of this cell TableCollection childTables = cell.getTables(); // If this cell has a table as a child then return true if (childTables.getCount() > 0) tableCount++; } } // No cell contains a table return tableCount; }
public CompositeNode getAncestor(java.lang.Class ancestorType)
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.Example:
Shows how to find out if a table contains another table or if the table itself is nested inside another table.public void calculateDepthOfNestedTables() throws Exception { Document doc = new Document(getMyDir() + "Nested tables.docx"); NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true); for (int i = 0; i < tables.getCount(); i++) { // First lets find if any cells in the table have tables themselves as children int count = getChildTableCount((Table) tables.get(i)); System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count)); // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth int tableDepth = getNestedDepthOfTable((Table) tables.get(i)); if (tableDepth > 0) System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth)); else System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i)); } } /** * Calculates what level a table is nested inside other tables. * * @returns An integer containing the level the table is nested at. * 0 = Table is not nested inside any other table * 1 = Table is nested within one parent table * 2 = Table is nested within two parent tables etc.. */ private static int getNestedDepthOfTable(final Table table) { int depth = 0; int type = table.getNodeType(); // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table Node parent = table.getAncestor(table.getNodeType()); while (parent != null) { // Every time we find a table a level up we increase the depth counter and then try to find an // ancestor of type table from the parent depth++; parent = parent.getAncestor(Table.class); } return depth; } /** * Determines if a table contains any immediate child table within its cells. * Does not recursively traverse through those tables to check for further tables. * * @returns Returns true if at least one child cell contains a table. * Returns false if no cells in the table contains a table. */ private static int getChildTableCount(final Table table) { int tableCount = 0; // Iterate through all child rows in the table for (Row row : table.getRows()) { // Iterate through all child cells in the row for (Cell cell : row.getCells()) { // Retrieve the collection of child tables of this cell TableCollection childTables = cell.getTables(); // If this cell has a table as a child then return true if (childTables.getCount() > 0) tableCount++; } } // No cell contains a table return tableCount; }
public Node getChild(int nodeType, int index, boolean isDeep)
If index is out of range, a null is returned.
nodeType
- A 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.Example:
Shows how to traverse through a composite node's collection of child nodes.Document doc = new Document(); // Add two runs and one shape as child nodes to the first paragraph of this document. Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true); paragraph.appendChild(new Run(doc, "Hello world! ")); Shape shape = new Shape(doc, ShapeType.RECTANGLE); shape.setWidth(200.0); shape.setHeight(200.0); shape.setWrapType(WrapType.INLINE); paragraph.appendChild(shape); paragraph.appendChild(new Run(doc, "Hello again!")); // Iterate through the paragraph's collection of immediate children, // and print any runs or shapes that we find within. NodeCollection children = paragraph.getChildNodes(); Assert.assertEquals(3, paragraph.getChildNodes().getCount()); for (Node child : (Iterable<Node>) children) switch (child.getNodeType()) { case NodeType.RUN: System.out.println("Run contents:"); System.out.println("\t\"{child.GetText().Trim()}\""); break; case NodeType.SHAPE: Shape childShape = (Shape) child; System.out.println("Shape:"); System.out.println("\t{childShape.ShapeType}, {childShape.Width}x{childShape.Height}"); break; }
Example:
Shows how to apply attributes of a table's style directly to the table's elements.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); builder.write("Hello world!"); builder.endTable(); TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1"); tableStyle.setRowStripe(3); tableStyle.setCellSpacing(5.0); tableStyle.getShading().setBackgroundPatternColor(Color.WHITE); tableStyle.getBorders().setColor(Color.BLUE); tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH); table.setStyle(tableStyle); // This method concerns table style attributes such as the ones we set above. doc.expandTableStylesToDirectFormatting(); doc.save(getArtifactsDir() + "Document.TableStyleToDirectFormatting.docx");
public NodeCollection getChildNodes(int nodeType, boolean isDeep)
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.
nodeType
- A isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. Example:
Shows how to extract images from a document, and save them to the local file system as individual files.Document doc = new Document(getMyDir() + "Images.docx"); // Get the collection of shapes from the document, // and save the image data of every shape with an image as a file to the local file system. NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true); int imageIndex = 0; for (Shape shape : (Iterable<Shape>) shapes) { if (shape.hasImage()) { // The image data of shapes may contain images of many possible image formats. // We can determine a file extension for each image automatically, based on its format. String imageFileName = MessageFormat.format("File.ExtractImages.{0}{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType())); shape.getImageData().save(getArtifactsDir() + imageFileName); imageIndex++; } }
Example:
Shows how to print all of a document's comments and their replies.Document doc = new Document(getMyDir() + "Comments.docx"); NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true); // If a comment has no ancestor, it is a "top-level" comment as opposed to a reply-type comment. // Print all top-level comments along with their replies, if there are any. for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { System.out.println("Top-level comment:"); System.out.println("\t\"{comment.GetText().Trim()}\", by {comment.Author}"); System.out.println("Has {comment.Replies.Count} replies"); for (Comment commentReply : comment.getReplies()) { System.out.println("\t\"{commentReply.GetText().Trim()}\", by {commentReply.Author}"); } System.out.println(); } }
public java.lang.String getText()
The returned string includes all control and special characters as described in
Example:
Shows how to output all paragraphs in a document that are bulleted or numbered.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getListFormat().applyNumberDefault(); builder.writeln("Numbered list item 1"); builder.writeln("Numbered list item 2"); builder.writeln("Numbered list item 3"); builder.getListFormat().removeNumbers(); builder.getListFormat().applyBulletDefault(); builder.writeln("Bulleted list item 1"); builder.writeln("Bulleted list item 2"); builder.writeln("Bulleted list item 3"); builder.getListFormat().removeNumbers(); NodeCollection paras = doc.getChildNodes(NodeType.PARAGRAPH, true); for (Paragraph para : (Iterable<Paragraph>) paras) { if (para.getListFormat().isListItem()) { System.out.println(java.text.MessageFormat.format("*** A paragraph belongs to list {0}", para.getListFormat().getList().getListId())); System.out.println(para.getText()); } }
Example:
Shows the difference between calling the GetText and ToString methods on a node.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField("MERGEFIELD Field"); // GetText will retrieve the visible text as well as field codes and special characters. Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText()); // ToString will give us the document's appearance if saved to a passed save format. Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));
public int indexOf(Node child)
Example:
Shows how to get the index of a given child node from its parent.Document doc = new Document(getMyDir() + "Rendering.docx"); Body body = doc.getFirstSection().getBody(); // Retrieve the index of the last paragraph in the body of the first section. Assert.assertEquals(24, body.getChildNodes().indexOf(body.getLastParagraph()));
public Node insertAfter(Node newChild, Node refChild) throws java.lang.Exception
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
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newNode is placed after the refNode. Example:
Shows how to add, update and delete child nodes in a CompositeNode's collection of children.Document doc = new Document(); // An empty document, by default, has one paragraph. Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount()); // Composite nodes such as our paragraph can contain other composite and inline nodes as children. Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // Create three more run nodes. Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // The document body will not display these runs until we insert them into a composite node // that itself is a part of the document's node tree, as we did with the first run. // We can determine where the text contents of nodes that we insert // appears in the document by specifying an insertion location relative to another node in the paragraph. Assert.assertEquals("Initial text.", paragraph.getText().trim()); // Insert the second run into the paragraph in front of the initial run. paragraph.insertBefore(run2, paragraphText); Assert.assertEquals("Run 2. Initial text.", paragraph.getText().trim()); // Insert the third run after the initial run. paragraph.insertAfter(run3, paragraphText); Assert.assertEquals("Run 2. Initial text. Run 3.", paragraph.getText().trim()); // Insert the first run to the start of the paragraph's child nodes collection. 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()); // We can modify the contents of the run by editing and deleting existing child nodes. ((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());
Example:
Shows how to replace all textboxes with images.Document doc = new Document(getMyDir() + "Textboxes in drawing canvas.docx"); // This gets a live collection of all shape nodes in the document NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true); // Since we will be adding/removing nodes, it is better to copy all collection // into a fixed size array, otherwise iterator will be invalidated Node[] shapes = shapeCollection.toArray(); for (Node node : shapes) { Shape shape = (Shape) node; // Filter out all shapes that we don't need if (shape.getShapeType() == ShapeType.TEXT_BOX) { // Create a new shape that will replace the existing shape Shape image = new Shape(doc, ShapeType.IMAGE); // Load the image into the new shape image.getImageData().setImage(getImageDir() + "Windows MetaFile.wmf"); // Make new shape's position to match the old shape image.setLeft(shape.getLeft()); image.setTop(shape.getTop()); image.setWidth(shape.getWidth()); image.setHeight(shape.getHeight()); image.setRelativeHorizontalPosition(shape.getRelativeHorizontalPosition()); image.setRelativeVerticalPosition(shape.getRelativeVerticalPosition()); image.setHorizontalAlignment(shape.getHorizontalAlignment()); image.setVerticalAlignment(shape.getVerticalAlignment()); image.setWrapType(shape.getWrapType()); image.setWrapSide(shape.getWrapSide()); // Insert new shape after the old shape and remove the old shape shape.getParentNode().insertAfter(image, shape); shape.remove(); } } doc.save(getArtifactsDir() + "Shape.ReplaceTextboxesWithImages.docx");
public Node insertBefore(Node newChild, Node refChild) throws java.lang.Exception
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
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newChild is placed before this node.Example:
Shows how to add, update and delete child nodes in a CompositeNode's collection of children.Document doc = new Document(); // An empty document, by default, has one paragraph. Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount()); // Composite nodes such as our paragraph can contain other composite and inline nodes as children. Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // Create three more run nodes. Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // The document body will not display these runs until we insert them into a composite node // that itself is a part of the document's node tree, as we did with the first run. // We can determine where the text contents of nodes that we insert // appears in the document by specifying an insertion location relative to another node in the paragraph. Assert.assertEquals("Initial text.", paragraph.getText().trim()); // Insert the second run into the paragraph in front of the initial run. paragraph.insertBefore(run2, paragraphText); Assert.assertEquals("Run 2. Initial text.", paragraph.getText().trim()); // Insert the third run after the initial run. paragraph.insertAfter(run3, paragraphText); Assert.assertEquals("Run 2. Initial text. Run 3.", paragraph.getText().trim()); // Insert the first run to the start of the paragraph's child nodes collection. 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()); // We can modify the contents of the run by editing and deleting existing child nodes. ((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());
public java.util.Iterator<Node> iterator()
Example:
Shows how to traverse through a composite node's collection of child nodes.Document doc = new Document(); // Add two runs and one shape as child nodes to the first paragraph of this document. Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true); paragraph.appendChild(new Run(doc, "Hello world! ")); Shape shape = new Shape(doc, ShapeType.RECTANGLE); shape.setWidth(200.0); shape.setHeight(200.0); shape.setWrapType(WrapType.INLINE); paragraph.appendChild(shape); paragraph.appendChild(new Run(doc, "Hello again!")); // Iterate through the paragraph's collection of immediate children, // and print any runs or shapes that we find within. NodeCollection children = paragraph.getChildNodes(); Assert.assertEquals(3, paragraph.getChildNodes().getCount()); for (Node child : (Iterable<Node>) children) switch (child.getNodeType()) { case NodeType.RUN: System.out.println("Run contents:"); System.out.println("\t\"{child.GetText().Trim()}\""); break; case NodeType.SHAPE: Shape childShape = (Shape) child; System.out.println("Shape:"); System.out.println("\t{childShape.ShapeType}, {childShape.Width}x{childShape.Height}"); break; }
public Node nextPreOrder(Node rootNode)
rootNode
- The top node (limit) of traversal.public Node prependChild(Node newChild) throws java.lang.Exception
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
newChild
- The node to add.Example:
Shows how to add, update and delete child nodes in a CompositeNode's collection of children.Document doc = new Document(); // An empty document, by default, has one paragraph. Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount()); // Composite nodes such as our paragraph can contain other composite and inline nodes as children. Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // Create three more run nodes. Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // The document body will not display these runs until we insert them into a composite node // that itself is a part of the document's node tree, as we did with the first run. // We can determine where the text contents of nodes that we insert // appears in the document by specifying an insertion location relative to another node in the paragraph. Assert.assertEquals("Initial text.", paragraph.getText().trim()); // Insert the second run into the paragraph in front of the initial run. paragraph.insertBefore(run2, paragraphText); Assert.assertEquals("Run 2. Initial text.", paragraph.getText().trim()); // Insert the third run after the initial run. paragraph.insertAfter(run3, paragraphText); Assert.assertEquals("Run 2. Initial text. Run 3.", paragraph.getText().trim()); // Insert the first run to the start of the paragraph's child nodes collection. 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()); // We can modify the contents of the run by editing and deleting existing child nodes. ((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());
public Node previousPreOrder(Node rootNode)
rootNode
- The top node (limit) of traversal.public void remove()
Example:
Shows how to remove all child 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()); 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(); } curNode = nextNode; } Assert.assertEquals(0, doc.getChildNodes(NodeType.TABLE, true).getCount());
public void removeAllChildren()
Example:
Shows how to construct an Aspose.Words document by hand.Document doc = new Document(); // A blank document contains one section, one body and one paragraph. // Call the "RemoveAllChildren" method to remove all those nodes, // and end up with a document node with no children. doc.removeAllChildren(); // This document now has no composite child nodes that we can add content to. // If we wish to edit it, we will need to repopulate its node collection. // First, create a new section, and then append it as a child to the root document node. Section section = new Section(doc); doc.appendChild(section); // Set some page setup properties for the section. section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE); section.getPageSetup().setPaperSize(PaperSize.LETTER); // A section needs a body, which will contain and display all of its contents // on the page between the section's header and footer. Body body = new Body(doc); section.appendChild(body); // Create a paragraph, set some formatting properties, and then append it as a child to the body. Paragraph para = new Paragraph(doc); para.getParagraphFormat().setStyleName("Heading 1"); para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); body.appendChild(para); // Finally, add some content to do the document by creating a run, // setting its text contents and appearance, and appending it as a child to the paragraph. Run run = new Run(doc); run.setText("Hello World!"); run.getFont().setColor(Color.RED); para.appendChild(run); Assert.assertEquals("Hello World!", doc.getText().trim()); doc.save(getArtifactsDir() + "Section.CreateManually.docx");
public void removeAllReplies() throws java.lang.Exception
Example:
Shows how to remove comment replies.Document doc = new Document(); Comment comment = new Comment(doc, "John Doe", "J.D.", new Date()); comment.setText("My comment."); doc.getFirstSection().getBody().getFirstParagraph().appendChild(comment); comment.addReply("Joe Bloggs", "J.B.", new Date(), "New reply"); comment.addReply("Joe Bloggs", "J.B.", new Date(), "Another reply"); Assert.assertEquals(2, comment.getReplies().getCount()); // We can remove replies from a comment individually. comment.removeReply(comment.getReplies().get(0)); Assert.assertEquals(1, comment.getReplies().getCount()); // We can also remove all of a comment's replies at once with this method. comment.removeAllReplies(); Assert.assertEquals(0, comment.getReplies().getCount());
public Node removeChild(Node oldChild)
The parent of oldChild is set to null after the node is removed.
oldChild
- The node to remove.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); 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());
public void removeReply(Comment reply) throws java.lang.Exception
reply
- The comment node of the deleting reply.Example:
Shows how to remove comment replies.Document doc = new Document(); Comment comment = new Comment(doc, "John Doe", "J.D.", new Date()); comment.setText("My comment."); doc.getFirstSection().getBody().getFirstParagraph().appendChild(comment); comment.addReply("Joe Bloggs", "J.B.", new Date(), "New reply"); comment.addReply("Joe Bloggs", "J.B.", new Date(), "Another reply"); Assert.assertEquals(2, comment.getReplies().getCount()); // We can remove replies from a comment individually. comment.removeReply(comment.getReplies().get(0)); Assert.assertEquals(1, comment.getReplies().getCount()); // We can also remove all of a comment's replies at once with this method. comment.removeAllReplies(); Assert.assertEquals(0, comment.getReplies().getCount());
public void removeSmartTags() throws java.lang.Exception
Example:
Removes all smart tags from descendant nodes of a composite node.Document doc = new Document(getMyDir() + "Smart tags.doc"); Assert.assertEquals(8, doc.getChildNodes(NodeType.SMART_TAG, true).getCount()); doc.removeSmartTags(); Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
public NodeList selectNodes(java.lang.String xpath)
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.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. 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. 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 use an XPath expression to test whether a node is inside a field.Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx"); // The NodeList that results from this XPath expression will contain all nodes we find inside a field. // However, FieldStart and FieldEnd nodes can be on 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()}");
public Node selectSingleNode(java.lang.String xpath)
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.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. 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. 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());
public void setText(java.lang.String text) throws java.lang.Exception
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.
text
- The new text of the comment.Example:
Shows how to add a comment to a document, and then reply to it.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Comment comment = new Comment(doc, "John Doe", "J.D.", new Date()); comment.setText("My comment."); // Place the comment at a node in the document's body. // This comment will show up at the location of its paragraph, // outside the right side margin of the page, and with a dotted line connecting it to its paragraph. builder.getCurrentParagraph().appendChild(comment); // Add a reply, which will show up under its parent comment. comment.addReply("Joe Bloggs", "J.B.", new Date(), "New reply"); // Comments and replies are both Comment nodes. Assert.assertEquals(2, doc.getChildNodes(NodeType.COMMENT, true).getCount()); // Comments that do not reply to other comments are "top-level", and have no ancestor. Assert.assertNull(comment.getAncestor()); // Replies have an ancestor top-level comment. Assert.assertEquals(comment, comment.getReplies().get(0).getAncestor()); doc.save(getArtifactsDir() + "Comment.AddCommentWithReply.docx");
public java.lang.String toString(SaveOptions saveOptions) throws java.lang.Exception
saveOptions
- Specifies the options that control how the node is saved.Example:
Exports the content of a node to String in HTML format.Document doc = new Document(getMyDir() + "Document.docx"); Node node = doc.getLastSection().getBody().getLastParagraph(); // When we call the ToString method using the html SaveFormat overload, // it converts the node's contents to their raw html representation. 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));
public java.lang.String toString(int saveFormat) throws java.lang.Exception
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"); Node node = doc.getLastSection().getBody().getLastParagraph(); // When we call the ToString method using the html SaveFormat overload, // it converts the node's contents to their raw html representation. Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" + "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" + "</p>", node.toString(SaveFormat.HTML)); // We can also modify the result of this conversion using a SaveOptions object. HtmlSaveOptions saveOptions = new HtmlSaveOptions(); saveOptions.setExportRelativeFontSize(true); Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" + "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" + "</p>", node.toString(saveOptions));
Example:
Shows the difference between calling the GetText and ToString methods on a node.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField("MERGEFIELD Field"); // GetText will retrieve the visible text as well as field codes and special characters. Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText()); // ToString will give us the document's appearance if saved to a passed save format. Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));