Skip to main content

GetComments

Returns all comments from the current worksheet.

Syntax​

expression.GetComments();

expression - A variable that represents a ApiWorksheet class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiComment[]

Example​

This example shows how to get an array of ApiComment objects.

var oWorksheet = Api.GetActiveSheet();
oWorksheet.GetRange("A1").SetValue("1");
var oRange = oWorksheet.GetRange("A1");
oRange.AddComment("This is just a number.");
var aComments = oWorksheet.GetComments();
oWorksheet.GetRange("A4").SetValue("Comment: " + aComments[0].GetText());