跳到主要内容

AddComment

Adds a comment to the current run. 💡 Please note that this run must be in the document.

Syntax

expression.AddComment(sText, sAuthor, sUserId);

expression - A variable that represents a ApiRun class.

Parameters

NameRequired/OptionalData typeDefaultDescription
sTextRequiredstringThe comment text (required).
sAuthorRequiredstringThe author's name (optional).
sUserIdRequiredstringThe user ID of the comment author (optional).

Returns

ApiComment

Example

This example adds a comment to the run.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let run = Api.CreateRun();
run.AddText("This is just a sample text. Nothing special.");
paragraph.AddElement(run);
run.AddComment("comment", "John Smith");