Get Started
Usage API
More information

ApiComment

new ApiComment()

Class representing a comment.

Properties

Name Type Description
Text string

Returns the text from the first cell in range.

Methods

Name Description
Delete

Deletes the ApiComment object.

GetClassType

Returns a type of the ApiComment class.

GetText

Returns the comment text.

Example

Copy code
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
oWorksheet.GetRange("A1").SetValue("1");
var oRange = oWorksheet.GetRange("A1");
oRange.AddComment("This is just a number.");
var oComment = oRange.GetComment();
oWorksheet.GetRange("A3").SetValue("Comment: " + oComment.GetText());
var sType = oComment.GetClassType();
oWorksheet.GetRange("A4").SetValue("Type: " + sType + " (number of comment data type)");
builder.SaveFile("xlsx", "ApiComment.xlsx");
builder.CloseFile();

Resulting document