CommentRangeEnd class
CommentRangeEnd class
Denotes the end of a region of text that has a comment associated with it. To learn more, visit the Working with Comments documentation article.
Remarks
To create a comment anchored to a region of text, you need to create a Comment and then create CommentRangeStart and CommentRangeEnd and set their identifiers to the same Comment.id value.
CommentRangeEnd is an inline-level node and can only be a child of Paragraph.
Inheritance: CommentRangeEnd → Node
Constructors
| Name | Description |
|---|---|
| CommentRangeEnd(doc, id) | Initializes a new instance of this class. |
Properties
| Name | Description |
|---|---|
| custom_node_id | Specifies custom node identifier. (Inherited from Node) |
| document | Gets the document to which this node belongs. (Inherited from Node) |
| id | Specifies the identifier of the comment to which this region is linked to. |
| is_composite | Returns True if this node can contain other nodes.(Inherited from Node) |
| next_sibling | Gets the node immediately following this node. (Inherited from Node) |
| node_type | Returns NodeType.COMMENT_RANGE_END. |
| parent_node | Gets the immediate parent of this node. (Inherited from Node) |
| previous_sibling | 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) |
Methods
| Name | Description |
|---|---|
| accept(visitor) | Accepts a visitor. |
| clone(is_clone_children) | Creates a duplicate of the node. (Inherited from Node) |
| get_ancestor(ancestor_type) | Gets the first ancestor of the specified object type. (Inherited from Node) |
| get_ancestor(ancestor_type) | Gets the first ancestor of the specified NodeType. (Inherited from Node) |
| get_text() | Gets the text of this node and of all its children. (Inherited from Node) |
| next_pre_order(root_node) | Gets next node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| node_type_to_string(node_type) | A utility method that converts a node type enum value into a user friendly string. (Inherited from Node) |
| previous_pre_order(root_node) | Gets the previous node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| remove() | Removes itself from the parent. (Inherited from Node) |
| to_string(save_format) | Exports the content of the node into a string in the specified format. (Inherited from Node) |
| to_string(save_options) | Exports the content of the node into a string using the specified save options. (Inherited from Node) |
See Also
- module aspose.words
- class Node
- class Comment
- class CommentRangeStart