formatRows - cfsimplicity/spreadsheet-cfml GitHub Wiki

Formats/styles the contents of multiple rows.

formatRows( workbook, format, range[, overwriteCurrentStyle [, cellStyle  ] ] )

Required arguments

  • workbook spreadsheet object
  • format struct OR cellStyle object: See Formatting options for details. Optional if cellStyle supplied.
  • range string: a comma-delimited list of ranges. Each value can be either a single number, a range of numbers with a hyphen, e.g. "1,2-5", or an open-ended range, e.g. "2-" (meaning all starting from 2).

Optional arguments

  • overwriteCurrentStyle boolean default=true: for performance/efficiency reasons all of the existing styles will be completely overwritten when using this method. To preserve existing formatting properties other than the ones being changed, set this flag to false, but please note that this should only be used when formatting a limited number of cells (you may run into errors if applied to too many cells).

Chainable? Yes.

Example

data = QueryNew( "First,Last","VarChar,VarChar",[ [ "Susi","Sorglos" ],[ "Frumpo","McNugget" ] ] );
spreadsheet = New spreadsheet();
workbook = spreadsheet.workbookFromQuery( data );
spreadsheet.formatRows( workbook,{bold="true"},"1-2" );