Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

XL.Sheet.GetHidden

Returns whether sheet is hidden.

Component Version macOS Windows Linux Server iOS SDK
XL 3.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.Sheet.GetHidden"; bookRef; sheetIndex )   More

Parameters

Parameter Description Example
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

Result

Returns boolean or error message.

Description

Returns whether sheet is hidden.
Value is 1 if sheet is hidden and 0 if sheet is visible.
And value is 2 if sheet is hidden and cannot be shown in the user interface.

See also

This function checks for a license.

Created 18th August 2014, last changed 21st August 2023


XL.Sheet.GetHeaderMargin - XL.Sheet.GetHorPageBreak