java.lang.ObjectNode
CompositeNode
InlineStory
com.aspose.words.Comment
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:
Constructor Summary |
---|
Comment(DocumentBase doc)
Initializes a new instance of the Comment class. |
Comment(DocumentBase doc, java.lang.String author, java.lang.String initial, java.util.Date dateTime)
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.String value) | |
Returns or sets the author name for a comment. | ||
NodeCollection | getChildNodes() | → inherited from CompositeNode |
Gets all immediate child nodes of this node. | ||
int | getCount() | → inherited from CompositeNode |
Gets the number of immediate children of this node. | ||
java.util.Date | getDateTime() | |
void | setDateTime(java.util.Date value) | |
Gets the date and time that the comment was made. | ||
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
boolean | getDone() | |
void | setDone(boolean value) | |
Gets or sets flag indicating that the comment has been marked done. | ||
Node | getFirstChild() | → inherited from CompositeNode |
Gets the first child of the node. | ||
Paragraph | getFirstParagraph() | → inherited from InlineStory |
Gets the first paragraph in the story. | ||
Font | getFont() | → inherited from InlineStory |
Provides access to the font formatting of the anchor character of this object. | ||
boolean | hasChildNodes() | → inherited from CompositeNode |
Returns true if this node has any child nodes. | ||
int | getId() | |
Gets the comment identifier. | ||
java.lang.String | getInitial() | |
void | setInitial(java.lang.String value) | |
Returns or sets the initials of the user associated with a specific comment. | ||
boolean | isComposite() | → inherited from CompositeNode |
Returns true as this node can have child nodes. | ||
boolean | isDeleteRevision() | → inherited from InlineStory |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isInsertRevision() | → inherited from InlineStory |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled. | ||
Node | getLastChild() | → inherited from CompositeNode |
Gets the last child of the node. | ||
Paragraph | getLastParagraph() | → inherited from InlineStory |
Gets the last paragraph in the story. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
int | getNodeType() | |
Returns NodeType.Comment. The value of the property is NodeType integer constant. | ||
ParagraphCollection | getParagraphs() | → inherited from InlineStory |
Gets a collection of paragraphs that are immediate children of the story. | ||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Paragraph | getParentParagraph() | → inherited from InlineStory |
Retrieves the parent |
||
Node | getPreviousSibling() | → inherited from Node |
Gets the node immediately preceding this node. | ||
Range | getRange() | → inherited from Node |
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. | ||
Aspose.Words.Tables.TableCollection | getTables() | → inherited from InlineStory |
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) | → inherited from CompositeNode |
Adds the specified node to the end of the list of child nodes for this node. | ||
void | clearRunAttrs() | → inherited from InlineStory |
Reserved for internal use. | ||
Node | deepClone(boolean isCloneChildren) | → inherited from Node |
Creates a duplicate of the node. | ||
void | ensureMinimum() | → inherited from InlineStory |
If the last child is not a paragraph, creates and appends one empty paragraph. | ||
java.lang.Object | fetchInheritedRunAttr(int fontAttr) | → inherited from InlineStory |
Reserved for internal use. | ||
CompositeNode | getAncestor(int ancestorType) | → inherited from Node |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object type. | ||
Node | getChild(int nodeType, int index, boolean isDeep) | → inherited from CompositeNode |
Returns an Nth child node that matches the specified type. | ||
NodeCollection | getChildNodes(int nodeType, boolean isDeep) | → inherited from CompositeNode |
Returns a live collection of child nodes that match the specified type. | ||
CompositeNode | getContainer() | → inherited from CompositeNode |
Reserved for internal use. | ||
java.lang.Object | getDirectRunAttr(int fontAttr) | → inherited from InlineStory |
Reserved for internal use. | ||
int | getDirectRunAttrsCount() | → inherited from InlineStory |
Reserved for internal use. | ||
DocumentBase | getDocument_IInline() | → inherited from InlineStory |
Reserved for internal use. | ||
aspose.obfuscated.type | getExpandedRunPr_IInline(aspose.obfuscated.type flags) | → inherited from InlineStory |
Reserved for internal use. | ||
int | getId_INodeWithAnnotationId() | |
Reserved for internal use. | ||
Node | getNextMatchingNode(aspose.obfuscated.type curNode) | → inherited from CompositeNode |
Reserved for internal use. | ||
Paragraph | getParentParagraph_IInline() | → inherited from InlineStory |
Reserved for internal use. | ||
aspose.obfuscated.type | getRunPr_IInline() | → inherited from InlineStory |
Reserved for internal use. | ||
java.lang.String | getText() | → inherited from CompositeNode |
Gets the text of this node and of all its children. | ||
int | indexOf(Node child) | → inherited from CompositeNode |
Returns the index of the specified child node in the child node array. | ||
Node | insertAfter(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately after the specified reference node. | ||
Node | insertBefore(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately before the specified reference node. | ||
java.util.Iterator | iterator() | → inherited from CompositeNode |
Provides support for the for each style iteration over the child nodes of this node. | ||
Node | nextPreOrder(Node rootNode) | → inherited from Node |
Gets next node according to the pre-order tree traversal algorithm. | ||
Node | prependChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the beginning of the list of child nodes for this node. | ||
Node | previousPreOrder(Node rootNode) | → inherited from Node |
Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | → inherited from Node |
Removes itself from the parent. | ||
void | removeAllChildren() | → inherited from CompositeNode |
Removes all the child nodes of the current node. | ||
void | removeAllReplies() | |
Removes all replies to this comment. | ||
Node | removeChild(Node oldChild) | → inherited from CompositeNode |
Removes the specified child node. | ||
void | removeReply(Comment reply) | |
Removes the specified reply to this comment. | ||
void | removeRunAttr(int key) | → inherited from InlineStory |
Reserved for internal use. | ||
void | removeSmartTags() | → inherited from CompositeNode |
Removes all |
||
NodeList | selectNodes(java.lang.String xpath) | → inherited from CompositeNode |
Selects a list of nodes matching the XPath expression. | ||
Node | selectSingleNode(java.lang.String xpath) | → inherited from CompositeNode |
Selects the first Node that matches the XPath expression. | ||
void | setId_INodeWithAnnotationId(int value) | |
Reserved for internal use. | ||
void | setRunAttr(int fontAttr, java.lang.Object value) | → inherited from InlineStory |
Reserved for internal use. | ||
void | setRunPr_IInline(aspose.obfuscated.type value) | → inherited from InlineStory |
Reserved for internal use. | ||
void | setText(java.lang.String text) | |
This is a convenience method that allows to easily set text of the comment. | ||
java.lang.String | toString(int saveFormat) | → inherited from Node |
Exports the content of the node into a string in the specified format. | ||
java.lang.String | toTxt() | → inherited from Node |
Exports the content of the node into a string in plain text format. |
Constructor Detail |
---|
public Comment(DocumentBase doc)
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.public Comment(DocumentBase doc, java.lang.String author, java.lang.String initial, java.util.Date dateTime)
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.Property Getters/Setters Detail |
---|
getAncestor | |
public Comment getAncestor() |
getAuthor/setAuthor | |
public java.lang.String getAuthor() / public void setAuthor(java.lang.String value) |
Cannot be null.
Default is empty string.
getChildNodes | → inherited from CompositeNode |
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.
getCount | → inherited from CompositeNode |
public int getCount() |
getDateTime/setDateTime | |
public java.util.Date getDateTime() / public void setDateTime(java.util.Date value) |
Default is 03.01.0001.
getDocument | → inherited from Node |
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.
getDone/setDone | |
public boolean getDone() / public void setDone(boolean value) |
getFirstChild | → inherited from CompositeNode |
public Node getFirstChild() |
getFirstParagraph | → inherited from InlineStory |
public Paragraph getFirstParagraph() |
getFont | → inherited from InlineStory |
public Font getFont() |
hasChildNodes | → inherited from CompositeNode |
public boolean hasChildNodes() |
getId | |
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.
getInitial/setInitial | |
public java.lang.String getInitial() / public void setInitial(java.lang.String value) |
Cannot be null.
Default is empty string.
isComposite | → inherited from CompositeNode |
public boolean isComposite() |
isDeleteRevision | → inherited from InlineStory |
public boolean isDeleteRevision() |
isInsertRevision | → inherited from InlineStory |
public boolean isInsertRevision() |
getLastChild | → inherited from CompositeNode |
public Node getLastChild() |
getLastParagraph | → inherited from InlineStory |
public Paragraph getLastParagraph() |
getNextSibling | → inherited from Node |
public Node getNextSibling() |
getNodeType | |
public int getNodeType() |
getParagraphs | → inherited from InlineStory |
public ParagraphCollection getParagraphs() |
getParentNode | → inherited from Node |
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.
getParentParagraph | → inherited from InlineStory |
public Paragraph getParentParagraph() |
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
getRange | → inherited from Node |
public Range getRange() |
getReplies | |
public CommentCollection getReplies() |
getStoryType | |
public int getStoryType() |
getTables | → inherited from InlineStory |
public Aspose.Words.Tables.TableCollection getTables() |
Method Detail |
---|
accept | |
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.addReply | |
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.appendChild | → inherited from CompositeNode |
public Node appendChild(Node newChild) |
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.clearRunAttrs | → inherited from InlineStory |
public void clearRunAttrs() |
deepClone | → inherited from Node |
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.ensureMinimum | → inherited from InlineStory |
public void ensureMinimum() |
fetchInheritedRunAttr | → inherited from InlineStory |
public java.lang.Object fetchInheritedRunAttr(int fontAttr) |
getAncestor | → inherited from Node |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A getAncestor | → inherited from Node |
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.getChild | → inherited from CompositeNode |
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.getChildNodes | → inherited from CompositeNode |
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. getContainer | → inherited from CompositeNode |
public CompositeNode getContainer() |
getDirectRunAttr | → inherited from InlineStory |
public java.lang.Object getDirectRunAttr(int fontAttr) |
getDirectRunAttrsCount | → inherited from InlineStory |
public int getDirectRunAttrsCount() |
getDocument_IInline | → inherited from InlineStory |
public DocumentBase getDocument_IInline() |
getExpandedRunPr_IInline | → inherited from InlineStory |
public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags) |
getId_INodeWithAnnotationId | |
public int getId_INodeWithAnnotationId() |
getNextMatchingNode | → inherited from CompositeNode |
public Node getNextMatchingNode(aspose.obfuscated.type curNode) |
getParentParagraph_IInline | → inherited from InlineStory |
public Paragraph getParentParagraph_IInline() |
getRunPr_IInline | → inherited from InlineStory |
public aspose.obfuscated.type getRunPr_IInline() |
getText | → inherited from CompositeNode |
public java.lang.String getText() |
The returned string includes all control and special characters as described in
indexOf | → inherited from CompositeNode |
public int indexOf(Node child) |
insertAfter | → inherited from CompositeNode |
public Node insertAfter(Node newChild, Node refChild) |
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. insertBefore | → inherited from CompositeNode |
public Node insertBefore(Node newChild, Node refChild) |
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.iterator | → inherited from CompositeNode |
public java.util.Iterator iterator() |
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.prependChild | → inherited from CompositeNode |
public Node prependChild(Node newChild) |
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.previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.remove | → inherited from Node |
public void remove() |
removeAllChildren | → inherited from CompositeNode |
public void removeAllChildren() |
removeAllReplies | |
public void removeAllReplies() throws java.lang.Exception |
removeChild | → inherited from CompositeNode |
public Node removeChild(Node oldChild) |
The parent of oldChild is set to null after the node is removed.
oldChild
- The node to remove.removeReply | |
public void removeReply(Comment reply) throws java.lang.Exception |
reply
- The comment node of the deleting reply.removeRunAttr | → inherited from InlineStory |
public void removeRunAttr(int key) |
removeSmartTags | → inherited from CompositeNode |
public void removeSmartTags() |
selectNodes | → inherited from CompositeNode |
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.selectSingleNode | → inherited from CompositeNode |
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.setId_INodeWithAnnotationId | |
public void setId_INodeWithAnnotationId(int value) |
setRunAttr | → inherited from InlineStory |
public void setRunAttr(int fontAttr, java.lang.Object value) |
setRunPr_IInline | → inherited from InlineStory |
public void setRunPr_IInline(aspose.obfuscated.type value) |
setText | |
public void setText(java.lang.String text) |
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.toString | → inherited from Node |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.toTxt | → inherited from Node |
public java.lang.String toTxt() throws java.lang.Exception |
This method removes field codes and Microsoft Word control characters, uses CrLf
(or any other) combination of characters to mark ends of paragraphs in the resulting string.
It produces a different result from