Worksheet.VisibilityType Property
Gets or sets whether the current worksheet is visible, hidden or “very hidden”.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v19.1.Core.dll
Declaration
Property Value
| Type | Description |
|---|---|
| WorksheetVisibilityType | A WorksheetVisibilityType enumeration member that specifies the worksheet visibility type. |
Remarks
Set the VisibilityType property to WorksheetVisibilityType.Hidden to hide the worksheet. Set it to WorksheetVisibilityType.Visible to show the previously hidden worksheet again. You can also accomplish this via the Worksheet.Visible property.
Also, the VisibilityType property provides you with the capability to make the worksheet “very hidden” (WorksheetVisibilityType.VeryHidden). This is a specific mode that does not allow the worksheet to be shown again by end-users. To make a “very hidden” worksheet visible again, set the VisibilityType property to WorksheetVisibilityType.Visible or Worksheet.Visible to true.
If you hide a worksheet that is currently active, the next visible worksheet to the right of this worksheet is automatically activated. If there are no visible worksheets to the right of the hidden worksheet, the first visible worksheet to the left of this worksheet becomes active.
Note
A workbook must always contain at least one visible worksheet.
Example
This example demonstrates how to manage worksheet visibility in a workbook. To do this, use the following properties.
-
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.VisibilityTypeproperty 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.VisibilityTypeSetting 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
// 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;
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the VisibilityType property.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.