spreadsheetSetRowHidden

Shows or hides a row of the active sheet in a spreadsheet workbook. Rows are 1-based. The fluent member form is setRowHidden(row, hidden), with the shorthand members hideRow(row) and showRow(row) and the predicate isRowHidden(row).

spreadsheetSetRowHidden(spreadsheetObj, row, hidden) → returns any

This function requires RustCFML.  Not supported on Lucee, Adobe ColdFusion, etc.
  1. CFDocs
  2. Functions
  3. All CFML Functions
  4. spreadsheetSetRowHidden
  5. RustCFML
  6. 0 Issue
  7. Edit
See Also:   spreadsheetSetColumnHidden   spreadsheetSetRowHeight   spreadsheetNew

Argument Reference

spreadsheetObj any
Required

The spreadsheet workbook object.

row numeric
Required

1-based row index.

hidden boolean
Default: true

True to hide the row, false to show it (default true).
Values:
  • true
  • false

Compatibility

RustCFML:

Not supported on wasm32.

Examples
Sample code invoking the spreadsheetSetRowHidden function

Hide row 3 and check its hidden state.

wb = Spreadsheet("xlsx");
spreadsheetSetRowHidden(wb, 3, true);
writeDump(wb.isRowHidden(3));

Expected Result: true

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub