Skip to main content

GetComments

Returns all comments related to the whole workbook.

Syntax​

expression.GetComments();

expression - A variable that represents an Api class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiComment[]

Example​

Retrieve all comments added at the top level of a spreadsheet.

// How do I get a list of comments from the workbook level in a spreadsheet?

// Read the text and author of comments stored at the document level in a spreadsheet.

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