XL.Sheet.GetHidden
------------------

Returns whether sheet is hidden.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [XL](component_XL.md) | [3.5](newinversion35.md) | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |

MBS( "XL.Sheet.GetHidden"; BookRef; SheetIndex ) 

**MBS**( **"XL.Sheet.GetHidden";** /\* Returns whether sheet is hidden. \*/  
**$BookRef**; /\* The reference number for the workbook.e.g. $ref \*/   
**$SheetIndex**) /\* The index of the sheet. This number ranges from 0 to [XL.Book.SheetCount](XLBookSheetCount.md)-1.e.g. 0 \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| BookRef | The reference number for the workbook. | $ref |
| SheetIndex | The index of the sheet. This number ranges from 0 to [XL.Book.SheetCount](XLBookSheetCount.md)-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

- [XL.Book.SheetCount](XLBookSheetCount.md)
- [XL.Sheet.GetColHidden](XLSheetGetColHidden.md)
- [XL.Sheet.GetHeader](XLSheetGetHeader.md)
- [XL.Sheet.GetMerge](XLSheetGetMerge.md)
- [XL.Sheet.GetPaper](XLSheetGetPaper.md)
- [XL.Sheet.GetRowHidden](XLSheetGetRowHidden.md)
- [XL.Sheet.SetColHidden](XLSheetSetColHidden.md)
- [XL.Sheet.SetHeader](XLSheetSetHeader.md)
- [XL.Sheet.SetHidden](XLSheetSetHidden.md)
- [XL.Sheet.SetRowHidden](XLSheetSetRowHidden.md)

This function checks for a license.

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

  
[XL.Sheet.GetHeaderMargin](XLSheetGetHeaderMargin.md) - [XL.Sheet.GetHorPageBreak](XLSheetGetHorPageBreak.md)

[HTML Version](XLSheetGetHidden.shtml)