Comment class
Comment class
Represents a container for text of a comment. To learn more, visit the Working with Comments documentation article.
Remarks
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 Comment object occurs on its own, the comment is anchored to the position of the Comment object.
To anchor a comment to a region of text three objects are required: Comment, CommentRangeStart and CommentRangeEnd. All three objects need to share the same Comment.id value.
Comment is an inline-level node and can only be a child of Paragraph.
Comment can contain Paragraph and Table child nodes.
Inheritance: Comment → InlineStory → CompositeNode → Node
Constructors
| Name | Description |
|---|---|
| Comment(doc) | Initializes a new instance of the Comment class. |
| Comment(doc, author, initial, dateTime) | Initializes a new instance of the Comment class. |
Properties
| Name | Description |
|---|---|
| ancestor | Returns the parent Comment object. Returns null for top-level comments. |
| author | Returns or sets the author name for a comment. |
| count | Gets the number of immediate children of this node. (Inherited from CompositeNode) |
| customNodeId | Specifies custom node identifier. (Inherited from Node) |
| dateTime | Gets the date and time that the comment was made. |
| dateTimeUtc | Gets the UTC date and time that the comment was made. |
| document | Gets the document to which this node belongs. (Inherited from Node) |
| done | Gets or sets flag indicating that the comment has been marked done. |
| firstChild | Gets the first child of the node. (Inherited from CompositeNode) |
| firstParagraph | Gets the first paragraph in the story. (Inherited from InlineStory) |
| font | Provides access to the font formatting of the anchor character of this object. (Inherited from InlineStory) |
| hasChildNodes | Returns true if this node has any child nodes.(Inherited from CompositeNode) |
| id | Gets or sets the comment identifier. |
| initial | Returns or sets the initials of the user associated with a specific comment. |
| isComposite | Returns true if this node can contain other nodes.(Inherited from Node) |
| isDeleteRevision | Returns true if this object was deleted in Microsoft Word while change tracking was enabled. (Inherited from InlineStory) |
| isInsertRevision | Returns true if this object was inserted in Microsoft Word while change tracking was enabled. (Inherited from InlineStory) |
| isMoveFromRevision | Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.(Inherited from InlineStory) |
| isMoveToRevision | Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.(Inherited from InlineStory) |
| lastChild | Gets the last child of the node. (Inherited from CompositeNode) |
| lastParagraph | Gets the last paragraph in the story. (Inherited from InlineStory) |
| nextSibling | Gets the node immediately following this node. (Inherited from Node) |
| nodeType | Returns NodeType.Comment. |
| paragraphs | Gets a collection of paragraphs that are immediate children of the story. (Inherited from InlineStory) |
| parentId | Gets or sets the parent comment ID. A value of -1 means the comment has no parent. |
| parentNode | Gets the immediate parent of this node. (Inherited from Node) |
| parentParagraph | Retrieves the parent Paragraph of this node. (Inherited from InlineStory) |
| previousSibling | Gets the node immediately preceding this node. (Inherited from Node) |
| range | Returns a Range object that represents the portion of a document that is contained in this node. (Inherited from Node) |
| replies | Returns a collection of Comment objects that are immediate children of the specified comment. |
| storyType | Returns StoryType.Comments. |
| tables | Gets a collection of tables that are immediate children of the story. (Inherited from InlineStory) |
Methods
| Name | Description |
|---|---|
| addReply(author, initial, dateTime, text) | Adds a reply to this comment. |
| appendChild(newChild) | Adds the specified node to the end of the list of child nodes for this node. (Inherited from CompositeNode) |
| asBody() | Cast node to Body. (Inherited from Node) |
| asBookmarkEnd() | Cast node to BookmarkEnd. (Inherited from Node) |
| asBookmarkStart() | Cast node to BookmarkStart. (Inherited from Node) |
| asBuildingBlock() | Cast node to BuildingBlock. (Inherited from Node) |
| asCell() | Cast node to Cell. (Inherited from Node) |
| asComment() | Cast node to Comment. (Inherited from Node) |
| asCommentRangeEnd() | Cast node to CommentRangeEnd. (Inherited from Node) |
| asCommentRangeStart() | Cast node to CommentRangeStart. (Inherited from Node) |
| asCompositeNode() | Cast node to CompositeNode. (Inherited from Node) |
| asDocument() | Cast node to Node.document. (Inherited from Node) |
| asEditableRangeEnd() | Cast node to EditableRangeEnd. (Inherited from Node) |
| asEditableRangeStart() | Cast node to EditableRangeStart. (Inherited from Node) |
| asFieldEnd() | Cast node to FieldEnd. (Inherited from Node) |
| asFieldSeparator() | Cast node to FieldSeparator. (Inherited from Node) |
| asFieldStart() | Cast node to FieldStart. (Inherited from Node) |
| asFootnote() | Cast node to Footnote. (Inherited from Node) |
| asFormField() | Cast node to FormField. (Inherited from Node) |
| asGlossaryDocument() | Cast node to GlossaryDocument. (Inherited from Node) |
| asGroupShape() | Cast node to GroupShape. (Inherited from Node) |
| asHeaderFooter() | Cast node to HeaderFooter. (Inherited from Node) |
| asOfficeMath() | Cast node to OfficeMath. (Inherited from Node) |
| asParagraph() | Cast node to Paragraph. (Inherited from Node) |
| asRow() | Cast node to Row. (Inherited from Node) |
| asRun() | Cast node to Run. (Inherited from Node) |
| asSection() | Cast node to Section. (Inherited from Node) |
| asShape() | Cast node to Shape. (Inherited from Node) |
| asSmartTag() | Cast node to SmartTag. (Inherited from Node) |
| asSpecialChar() | Cast node to SpecialChar. (Inherited from Node) |
| asStructuredDocumentTag() | Cast node to StructuredDocumentTag. (Inherited from Node) |
| asStructuredDocumentTagRangeEnd() | Cast node to StructuredDocumentTagRangeEnd. (Inherited from Node) |
| asStructuredDocumentTagRangeStart() | Cast node to StructuredDocumentTagRangeStart. (Inherited from Node) |
| asSubDocument() | Cast node to SubDocument. (Inherited from Node) |
| asTable() | Cast node to Table. (Inherited from Node) |
| clone(isCloneChildren) | Creates a duplicate of the node. (Inherited from Node) |
| ensureMinimum() | If the last child is not a paragraph, creates and appends one empty paragraph. (Inherited from InlineStory) |
| getAncestor(ancestorType) | Gets the first ancestor of the specified NodeType. (Inherited from Node) |
| getBuildingBlock(index, isDeep) | Returns an Nth child BuildingBlock node. (Inherited from CompositeNode) |
| getChild(nodeType, index, isDeep) | Returns an Nth child node that matches the specified type. (Inherited from CompositeNode) |
| getChildNodes(nodeType, isDeep) | Returns a live collection of child nodes that match the specified type. (Inherited from CompositeNode) |
| getComment(index, isDeep) | Returns an Nth child Comment node. (Inherited from CompositeNode) |
| getEditableRangeStart(index, isDeep) | Returns an Nth child EditableRangeStart node. (Inherited from CompositeNode) |
| getFootnote(index, isDeep) | Returns an Nth child Footnote node. (Inherited from CompositeNode) |
| getGroupShape(index, isDeep) | Returns an Nth child GroupShape node. (Inherited from CompositeNode) |
| getOfficeMath(index, isDeep) | Returns an Nth child OfficeMath node. (Inherited from CompositeNode) |
| getParagraph(index, isDeep) | Returns an Nth child Paragraph node. (Inherited from CompositeNode) |
| getRun(index, isDeep) | Returns an Nth child Run node. (Inherited from CompositeNode) |
| getSdt(index, isDeep) | Returns an Nth child StructuredDocumentTag node. (Inherited from CompositeNode) |
| getSdtRangeEnd(index, isDeep) | Returns an Nth child StructuredDocumentTagRangeEnd node. (Inherited from CompositeNode) |
| getSdtRangeStart(index, isDeep) | Returns an Nth child StructuredDocumentTagRangeStart node. (Inherited from CompositeNode) |
| getShape(index, isDeep) | Returns an Nth child Shape node. (Inherited from CompositeNode) |
| getSmartTag(index, isDeep) | Returns an Nth child SmartTag node. (Inherited from CompositeNode) |
| getTable(index, isDeep) | Returns an Nth child Table node. (Inherited from CompositeNode) |
| getText() | Gets the text of this node and of all its children. (Inherited from Node) |
| indexOf(child) | Returns the index of the specified child node in the child node array. (Inherited from CompositeNode) |
| insertAfter(newChild, refChild) | Inserts the specified node immediately after the specified reference node. (Inherited from CompositeNode) |
| insertBefore(newChild, refChild) | Inserts the specified node immediately before the specified reference node. (Inherited from CompositeNode) |
| nextPreOrder(rootNode) | Gets next node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| nodeTypeToString(nodeType) | A utility method that converts a node type enum value into a user friendly string. (Inherited from Node) |
| prependChild(newChild) | Adds the specified node to the beginning of the list of child nodes for this node. (Inherited from CompositeNode) |
| previousPreOrder(rootNode) | Gets the previous node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| referenceEquals(other) | (Inherited from Node) |
| remove() | Removes itself from the parent. (Inherited from Node) |
| removeAllChildren() | Removes all the child nodes of the current node. (Inherited from CompositeNode) |
| removeAllReplies() | Removes all replies to this comment. |
| removeChild(oldChild) | Removes the specified child node. (Inherited from CompositeNode) |
| removeReply(reply) | Removes the specified reply to this comment. |
| removeSmartTags() | Removes all SmartTag descendant nodes of the current node. (Inherited from CompositeNode) |
| selectNodes(xpath) | Selects a list of nodes matching the XPath expression. (Inherited from CompositeNode) |
| selectSingleNode(xpath) | Selects the first Node that matches the XPath expression. (Inherited from CompositeNode) |
| setText(text) | This is a convenience method that allows to easily set text of the comment. |
| toString(saveFormat) | Exports the content of the node into a string in the specified format. (Inherited from Node) |
| toString(saveOptions) | Exports the content of the node into a string using the specified save options. (Inherited from Node) |
Examples
Shows how to add a comment to a document, and then reply to it.
let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);
let comment = new aw.Comment(doc, "John Doe", "J.D.", Date.now());
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.currentParagraph.appendChild(comment);
// Add a reply, which will show up under its parent comment.
comment.addReply("Joe Bloggs", "J.B.", Date.now(), "New reply");
// Comments and replies are both Comment nodes.
expect(doc.getChildNodes(aw.NodeType.Comment, true).count).toEqual(2);
// Comments that do not reply to other comments are "top-level". They have no ancestor comments.
expect(comment.ancestor).toBe(null);
// Replies have an ancestor top-level comment.
expect(comment.replies.at(0).ancestor).toEqual(comment);
doc.save(base.artifactsDir + "Comment.AddCommentWithReply.docx");
Shows how to add a comment to a paragraph.
let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);
builder.write("Hello world!");
var today = new Date(2024, 11, 26);
var comment = new aw.Comment(doc, "John Doe", "JD", today);
builder.currentParagraph.appendChild(comment);
builder.moveTo(comment.appendChild(new aw.Paragraph(doc)));
builder.write("Comment text.");
expect(comment.dateTime).toEqual(today);
// In Microsoft Word, we can right-click this comment in the document body to edit it, or reply to it.
doc.save(base.artifactsDir + "InlineStory.AddComment.docx");
See Also
- module Aspose.Words
- class InlineStory
- class CommentRangeStart
- class CommentRangeEnd