In This Topic ▼

IsSheetHidden Method

Summary

Determines whether a specified sheet within the Excel workbook is hidden. This method checks the visibility state of a sheet by its name.

Syntax

TypeScript

JavaScript

LEADWorkbook.prototype.isSheetHidden = function( 
   sheetName 
)

isSheetHidden( 
   sheetName: string 
): boolean;

Parameters

sheetName

A string specifying the name of the sheet whose visibility status is to be checked. The sheet name must exactly match an existing sheet in the workbook, including case sensitivity.

Return Value

true if the specified sheet is hidden; otherwise, false.

Remarks

The visibility of sheets in an Excel workbook can significantly impact user interaction and data presentation. Sheets may be hidden to simplify the user interface, protect sensitive information, or manage workflow within the workbook. This method provides a programmatic way to query the visibility state of sheets.

Requirements

Target Platforms