officefileapi-devexpress-dot-spreadsheet-dot-worksheet-449d9df8.md
Gets or sets whether the current worksheet is visible, hidden or “very hidden”.
Namespace : DevExpress.Spreadsheet
Assembly : DevExpress.Spreadsheet.v25.2.Core.dll
NuGet Package : DevExpress.Spreadsheet.Core
WorksheetVisibilityType VisibilityType { get; set; }
Property VisibilityType As WorksheetVisibilityType
| Type | Description |
|---|---|
| WorksheetVisibilityType |
A WorksheetVisibilityType enumeration member that specifies the worksheet visibility type.
|
Available values:
| 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.
|
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.
This example demonstrates how to manage worksheet visibility in a workbook. To do this, use the following properties.
Worksheet.VisibilityType
Note
A workbook must always contain at least one visible worksheet.
// 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;
' 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
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.
// To make this worksheet visible again, use the Worksheet.Visible property.
workbook.Worksheets["Sheet2"].VisibilityType = WorksheetVisibilityType.VeryHidden;
// To make this worksheet visible again, use the Worksheet.Visible property.
workbook.Worksheets["Sheet2"].VisibilityType = WorksheetVisibilityType.VeryHidden;
// Use the Worksheet.Visible property to unhide this worksheet.
workbook.Worksheets["Sheet2"].VisibilityType = WorksheetVisibilityType.VeryHidden;
' To make this worksheet visible again, use the Worksheet.Visible property.
workbook.Worksheets("Sheet2").VisibilityType = WorksheetVisibilityType.VeryHidden
' To make this worksheet visible again, use the Worksheet.Visible property.
workbook.Worksheets("Sheet2").VisibilityType = WorksheetVisibilityType.VeryHidden
' Use the Worksheet.Visible property to unhide this worksheet.
workbook.Worksheets("Sheet2").VisibilityType = WorksheetVisibilityType.VeryHidden
' Hide the "Sheet3" worksheet.
See Also