getCellComment - cfsimplicity/spreadsheet-cfml GitHub Wiki

Returns comment properties from a single cell as a struct, or from the entire active sheet as an array of structs.

getCellComment( workbook, row, column )

or

getCellComment( workbook )

Required arguments

  • workbook spreadsheet object

Optional arguments

  • row numeric: required if column is specified.
  • column numeric: required if row is specified.

Chainable? Yes but ends the chain.

Returned comment properties

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

Example

spreadsheet = New spreadsheet();
workbook = spreadsheet.new();
spreadsheet.addColumn( workbook,"a" );
theComment = {
 author="cfsimplicity"
 ,comment="This is the comment in row 1 column 1"
};
spreadsheet.setCellComment( workbook,theComment,1,1 );
comment = spreadsheet.getCellComment( workbook,1,1 );