Commenting a Document
Comments attach a note of a user to a range of text in a TXTextControl document, and other users can reply to them. The members below insert, edit, reply to, find and delete comments, read their text, author and time and report when the input position enters or leaves commented text.
Properties
| Member | Description |
|---|---|
TXTextControl.CommentCreationTime | Returns the date and time when the specified comment has been made. |
TXTextControl.CommentEnd | Returns the index (one-based) of the last character of the text associated with the specified comment. |
TXTextControl.CommentHighlightMode | This property returns or sets a value determining how commented text is highlighted in the document. |
TXTextControl.CommentReplies | Returns the identifiers of all replies of the specified comment. |
TXTextControl.CommentStart | Returns the index (one-based) of the first character of the text associated with the specified comment. |
TXTextControl.CommentText | Returns or sets the comment's text. |
TXTextControl.CommentUserName | Returns the name of the user who has commented the document. |
Methods
| Member | Description |
|---|---|
TXTextControl.CommentDelete | This method removes a comment from the document. |
TXTextControl.CommentEdit | This method opens a comment input control which the end-user can use to edit the specified comment. |
TXTextControl.CommentGetReplied | Gets the comment for which the specified comment is a reply. |
TXTextControl.CommentInsert | This method opens a comment input control which the end-user can use to insert a new comment in the document. |
TXTextControl.CommentNext | This method returns the identifier of the comment that follows the specified comment in the TXTextControl's current text. |
TXTextControl.CommentReply | This method opens a comment input control which the end-user can use to reply to the specified comment. |
Events
| Member | Description |
|---|---|
TXTextControl.CommentChanged | Occurs when the text of a comment has been changed. |
TXTextControl.CommentCreated | Occurs when a comment has been created. |
TXTextControl.CommentDeleted | Occurs when a comment has been deleted. |
TXTextControl.CommentedTextEntered | Occurs when the current input position indicated by the caret has been moved to a position that belongs to a commented piece of text. |
TXTextControl.CommentedTextLeft | Occurs when the current input position indicated by the caret has left a commented piece of text. |