WorksheetVisibilityType Enum

Contains the values that specify worksheet visibility.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v18.2.Core.dll

Declaration

C#

[Flags]
public enum WorksheetVisibilityType

VB.NET

<Flags>
Public Enum WorksheetVisibilityType

Members

Name	Description
Visible	A worksheet is visible.
Hidden	A worksheet is hidden.
VeryHidden	A worksheet is hidden and cannot be unhidden via the user interface.

Related API Members

The following properties accept/return WorksheetVisibilityType values:

• ChartSheet.VisibilityType
• SpreadsheetPrintOptions.PrintSheetVisibility
• Worksheet.VisibilityType

Remarks

This enumeration’s values are used by the Worksheet.VisibilityType property.

Example

This example demonstrates how to manage worksheet visibility in a workbook. To do this, use the following properties.

• Worksheet.Visible

  Set this property to false to hide a worksheet. To make a worksheet visible again, you can set the Visible property to true or the Worksheet.VisibilityType property to the WorksheetVisibilityType.Visible enumeration member. End-users can show a hidden worksheet via the user interface (for example, when opening a workbook in Microsoft® Excel® or SpreadsheetControl).

• Worksheet.VisibilityType

  Setting this property to WorksheetVisibilityType.Hidden is equivalent to setting the Worksheet.Visible property to false - the hidden worksheet can be shown again by end-users via the user interface (for example, Microsoft® Excel® or SpreadsheetControl).

  The VisibilityType property also allows you to hide a worksheet so that it becomes impossible for end-users to access this worksheet. To do this, mark a worksheet as “very hidden” by setting the VisibilityType property to WorksheetVisibilityType.VeryHidden. To show a worksheet again, set the Visible property to true or VisibilityType to WorksheetVisibilityType.Visible.

Note

A workbook must always contain at least one visible worksheet.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/spreadsheet-document-server-api-e4339

WorksheetActions.cs

// Hide the worksheet under the "Sheet2" name and prevent end-users from unhiding it via user interface.
// To make this worksheet visible again, use the Worksheet.Visible property.
workbook.Worksheets["Sheet2"].VisibilityType = WorksheetVisibilityType.VeryHidden;

// Hide the "Sheet3" worksheet. 
// In this state a worksheet can be unhidden via user interface.
workbook.Worksheets["Sheet3"].Visible = false;

WorksheetActions.vb

' Hide the worksheet under the "Sheet2" name and prevent end-users from unhiding it via user interface.
' To make this worksheet visible again, use the Worksheet.Visible property.
workbook.Worksheets("Sheet2").VisibilityType = WorksheetVisibilityType.VeryHidden

' Hide the "Sheet3" worksheet. 
' In this state a worksheet can be unhidden via user interface.
workbook.Worksheets("Sheet3").Visible = False