com.aspose.words

Class CommentRangeStart

java.lang.Object

com.aspose.words.Node

com.aspose.words.CommentRangeStart

All Implemented Interfaces:

java.lang.Cloneable

public final class CommentRangeStart
extends Node

Denotes the start of a region of text that has a comment associated with it.

To learn more, visit the Working with Comments documentation article.

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.getId() value.

CommentRangeStart is an inline-level node and can only be a child of Paragraph.

See Also:

Comment, CommentRangeEnd

Constructor Summary

Constructors

Constructor and Description
CommentRangeStart(DocumentBase doc, int id) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
int	getDisplacedByCustomXml()
int	getId() Specifies the identifier of the comment to which this region is linked.
int	getIdInternal()
int	getNodeType() Returns NodeType.COMMENT_RANGE_START.
int	getParentIdInternal()
void	setDisplacedByCustomXml(int value)
void	setId(int value) Specifies the identifier of the comment to which this region is linked.
void	setIdInternal(int value)
void	setParentIdInternal(int value)

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, getText, isComposite, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CommentRangeStart

public CommentRangeStart(DocumentBase doc,
                         int id)

Initializes a new instance of this class.

When CommentRangeStart is created, it belongs to the specified document, but is not yet part of the document and Node.getParentNode() is null.

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

Parameters:

doc - The owner document.

id - The comment identifier to which this object is linked.

Method Detail

getId

public final int getId()

Specifies the identifier of the comment to which this region is linked.

Returns:

The corresponding int value.

setId

public final void setId(int value)

Specifies the identifier of the comment to which this region is linked.

Parameters:

value - The corresponding int value.

getDisplacedByCustomXml

public final int getDisplacedByCustomXml()

setDisplacedByCustomXml

public final void setDisplacedByCustomXml(int value)

getIdInternal

public final int getIdInternal()

setIdInternal

public final void setIdInternal(int value)

getParentIdInternal

public final int getParentIdInternal()

setParentIdInternal

public final void setParentIdInternal(int value)

getNodeType

public final int getNodeType()

Returns NodeType.COMMENT_RANGE_START.

Specified by:

getNodeType in class Node

Returns:

NodeType.COMMENT_RANGE_START. The returned value is one of NodeType constants.

accept

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

Accepts a visitor.

Calls DocumentVisitor.visitCommentRangeStart(com.aspose.words.CommentRangeStart).

For more info see the Visitor design pattern.

Specified by:

accept in class Node

Parameters:

visitor - The visitor that will visit the node.

Returns:

False if the visitor requested the enumeration to stop.

Throws:

java.lang.Exception