Skip to content

Set Sheet Visibility Activity

The Set Sheet Visibility activity allows users to programmatically control the visibility of worksheets within an Excel workbook. By using either the sheet name or its numerical index, users can hide or show tabs to manage data security or streamline the user interface of the generated reports.

Field Description Requirement
Excel name Specifies the reference name of the Excel instance to be modified. Required
Sheet name Defines the name of the worksheet whose visibility status will be changed. Optional
Sheet index Defines the numerical position of the worksheet (starting from 1) to be modified. Optional
Visibility Sets the visibility state of the sheet. Available options are VISIBLE, HIDDEN or VERY_HIDDEN. Optional

Action Types & Examples

VISIBLE

  • Format: string
  • Example Result: The specified worksheet tab becomes visible at the bottom of the Excel window.

HIDDEN

  • Format: string
  • Example Result: The worksheet is removed from the tab bar. It remains in the file but is not visible to the user.

Implementation Examples

Field Setup

  • Excel name: AnnualReport
  • Sheet index: 2
  • Visibility: HIDDEN

Execution Parameters

  • Target Instance: AnnualReport
  • Action: The second sheet in the workbook is set to a hidden state.

Technical Notes

You can target a sheet using either Sheet name or Sheet index. If both are provided, the activity typically prioritizes the Sheet name. Note that Excel requires at least one worksheet to remain visible in a workbook at all times; attempting to hide all sheets will result in an error.