| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
XL.Sheet.SetHidden
Hides/unhides the sheet. Returns false if error occurs.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| XL | 13.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.Sheet.SetHidden"; bookRef; sheetIndex { ; hiddenState } ) More
Parameters
| Parameter | Description | Example | Flags |
|---|---|---|---|
| bookRef | The reference to the workbook. Please use XL.LoadBook to load a file. | $ref | |
| sheetIndex | The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. | 0 | |
| hiddenState | Whether to hide column. 0: visible 1: hidden 2: hidden and can't shown by user. Default is 0. |
1 | Optional |
Result
Returns OK or error.
Description
Hides/unhides the sheet. Returns false if error occurs.Examples
Make sheet visible:
Set Variable [ $r ; Value: MBS( "XL.Sheet.SetHidden"; $book; $sheet; 0) ]
Make sheet hidden:
Set Variable [ $r ; Value: MBS( "XL.Sheet.SetHidden"; $book; $sheet; 1) ]
See also
- XL.LoadBook
- XL.Sheet.GetHidden
- XL.Sheet.GetRowHidden
- XL.Sheet.SetColHidden
- XL.Sheet.SetColumn
- XL.Sheet.SetFooter
- XL.Sheet.SetHeader
- XL.Sheet.SetMerge
- XL.Sheet.SetPaper
- XL.Sheet.SetRowHidden
Release notes
- Version 13.4
- Added XL.Sheet.SetHidden function.
Blog Entries
Created 21st August 2023, last changed 27th August 2023
