spreadsheetSetColumnHidden

Shows or hides a column of the active sheet in a spreadsheet workbook. Columns are 1-based. The fluent member form is setColumnHidden(column, hidden), with the shorthand members hideColumn(column) and showColumn(column) and the predicate isColumnHidden(column).

spreadsheetSetColumnHidden(spreadsheetObj, column, hidden) → returns any

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

Argument Reference

spreadsheetObj any
Required

The spreadsheet workbook object.

column numeric
Required

1-based column index (1 = A).

hidden boolean
Default: true

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

Compatibility

RustCFML:

Not supported on wasm32.

Examples
Sample code invoking the spreadsheetSetColumnHidden function

Hide column 3 and check its hidden state.

wb = Spreadsheet("xlsx");
spreadsheetSetColumnHidden(wb, 3, true);
writeDump(wb.isColumnHidden(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