AddComment
Adds a comment to the specifed document element or array of Runs.
Syntax
expression.AddComment(element, text, author, userId);
expression - A variable that represents a Api class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| element | Required | ApiRun[] | DocumentElement | The element where the comment will be added. It may be applied to any element which has the AddComment method. | |
| text | Required | string | The comment text. | |
| author | Optional | string | The author's name. | |
| userId | Optional | string | The user ID of the comment author. |
Returns
Example
This example adds text and comment to the first paragraph.
- Code
- Result
// How to add a comment to the ApiParagraph class.
// How to comment on text.
// Adds a paragraph to the document and comments on it.
let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("ONLYOFFICE Document Builder");
Api.AddComment(paragraph, "ONLYOFFICE for developers", "Jane");