Skip to main content

AddComment

Returns an array of ApiComment objects.

Syntax

expression.AddComment(sText, sAuthor);

expression - A variable that represents a Api class.

Parameters

NameRequired/OptionalData typeDefaultDescription
sTextRequiredstringThe comment text.
sAuthorRequiredstringThe author's name (optional).

Returns

ApiComment | null

Example

This example adds a comment to the document.

Api.AddComment("Comment 1", "Bob");
Api.AddComment("Comment 2" );
var arrComments = Api.GetComments();
var oWorksheet = Api.GetActiveSheet();
oWorksheet.GetRange("A1").SetValue("Commet Text: ", arrComments[0].GetText());
oWorksheet.GetRange("B1").SetValue("Commet Author: ", arrComments[0].GetAuthorName());