AddComment
Adds a comment to the current range.
Syntax
expression.AddComment(sText, sAuthor, sUserId);
expression - A variable that represents a ApiRange class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| sText | Required | string | The comment text. | |
| sAuthor | Optional | string | The author's name. | |
| sUserId | Optional | string | The user ID of the comment author. |
Returns
Example
This example adds a comment to the range.
- Code
- Result
// How to comment a range of document.
// Insert a comment into the 'ONLYOFFICE' range and add an author to it.
let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("Document");
let range = doc.GetRange(0, 7);
range.AddText("ONLYOFFICE ", "before");
range.AddText(" Builder", "after");
range.AddComment("comment", "John Smith");