Comment module

class Comment.Comment

Bases: ParagraphBase, ICompositeObject

Represents a container for text of a comment.

AddItem(paraItem: IParagraphBase)

Adds the paragraph item to the commented items. :param paraItem: The paragraph item. :returns: None

property Body: Body

Gets comment body. :return: The text body.

property ByRepliedComment: Comment

Gets the comment of current comment replied. :return: Comment of by reply.

property ChildObjects: DocumentObjectCollection

Gets the child document objects. :return: The child entities.

Clear()

Clears the commented items.

property CommentMarkEnd: CommentMark

Gets the ending mark of the comment. :return: The commentMark of end.

property CommentMarkStart: CommentMark

Gets the beginning mark of the comment. :return: The commentMark of start.

property DocumentObjectType: DocumentObjectType

Gets the type of the document object. :return: The type of the document object.

EnsureMinimum()

Ensures the minimum. :returns: None

property Format: CommentFormat

Gets the format. :return: The format.

property Items: ParagraphItemCollection

Gets the range of commented items. :return: The range comment contains.

MarkCommentDone(done: bool)

Marks the comment done. :param done: The done. :returns: None

property MarkDone: bool

Gets a value indicating whether done. :return: True if done, False otherwise.

Replace

Replace commented items with matchString text. :param text: The text.

property ReplyCommentItems: CommentsCollection

Gets the range of commented items. :return: The reply commented range.

ReplyToComment(replyComment: Comment)

Replies to comment. :param replyComment: The reply comment. :returns: None