Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 12.2   12.3   12.4   12.5   13.0   13.1   13.2   13.3   13.4   13.5    Statistic    FMM    Blog  

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

Release notes

Blog Entries

Created 21st August 2023, last changed 27th August 2023


XL.Sheet.SetHeader - XL.Sheet.SetHorPageBreak

💬 Ask a question or report a problem