getCellComments - cfsimplicity/spreadsheet-cfml GitHub Wiki

Returns comment properties from the entire active sheet as an array of structs.

getCellComments( workbook )

Required arguments

• workbook spreadsheet object

Each returned comment has the following properties

• Author
• Column (number)
• Comment
• Row (number)

Chainable? Yes but ends the chain.

Example

spreadsheet = New spreadsheet();
workbook = spreadsheet.new();
data = [ [ "a", "b" ], [ "c", "d" ] ];
spreadsheet.addRows( workbook, data );
theComment = {
 author="cfsimplicity"
 ,comment="This is the comment in row 1 column 1"
};
spreadsheet.setCellComment( workbook,theComment, 1, 1 );
theComment = {
 author="cfsimplicity"
 ,comment="This is the comment in row 2 column 2"
};
spreadsheet.setCellComment( workbook, theComment, 2, 2 );
allComments = spreadsheet.getCellComments( workbook );//array of structs