AddComment

function AddComment(
  oElement: ApiRun[] | DocumentElement = null,
  sText: string = null,
  sAuthor: string = null,
  sUserId: string = null,
): ApiComment

Description

Adds a comment to the specifed document element or array of Runs.

Parameters

oElementApiRun[] | DocumentElementdefault: null

The element where the comment will be added. It may be applied to any element which has the AddComment method.

sTextstringdefault: null

The comment text (required).

sAuthorstringdefault: null

The author's name (optional).

sUserIdstringdefault: null

The user ID of the comment author (optional).

Returns

ApiComment

Try It

var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("ONLYOFFICE Document Builder");
Api.AddComment(oParagraph, "ONLYOFFICE for developers", "Jane");

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).