officefileapi-devexpress-dot-spreadsheet-dot-worksheet-c62912cc.md
Gets or sets whether the current worksheet is visible or hidden.
Namespace : DevExpress.Spreadsheet
Assembly : DevExpress.Spreadsheet.v25.2.Core.dll
NuGet Package : DevExpress.Spreadsheet.Core
bool Visible { get; set; }
Property Visible As Boolean
| Type | Description |
|---|---|
| Boolean |
true , if the worksheet is visible; otherwise, false.
|
Use the Visible property to control the visibility of the worksheet. To hide and unhide a worksheet, you can also use the Worksheet.VisibilityType property. It allows you to mark a worksheet as “very hidden”. In this mode, the worksheet cannot be accessed by end-users.
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.Visible
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 Visible 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.
worksheet["B2"].Value = "Workbook structure is protected with a password. \n You cannot add, move or delete worksheets until protection is removed.";
worksheet.Visible = true;
#endregion #ProtectWorkbook
workbook.Protect("password", true, false);
workbook.Worksheets[0].Visible = false;
Worksheet worksheet = workbook.Worksheets[1];
workbook.Protect("password", true, false);
workbook.Worksheets[0].Visible = false;
Worksheet worksheet = workbook.Worksheets[1];
// In this state, the worksheet can be unhidden via the user interface.
workbook.Worksheets["Sheet3"].Visible = false;
#endregion #ShowHideWorksheet
// In this state, the worksheet can be unhidden via the user interface.
workbook.Worksheets["Sheet3"].Visible = false;
#endregion #ShowHideWorksheet
worksheet("B2").Value = "Workbook structure is protected with a password. " & vbLf & " You cannot add, move or delete worksheets until protection is removed."
worksheet.Visible = True
' #End Region ' #ProtectWorkbook
End If
workbook.Worksheets(0).Visible = False
Dim worksheet As Worksheet = workbook.Worksheets(1)
End If
workbook.Worksheets(0).Visible = False
Dim worksheet As Worksheet = workbook.Worksheets(1)
' In this state, the worksheet can be unhidden via the user interface.
workbook.Worksheets("Sheet3").Visible = False
' #End Region ' #ShowHideWorksheet
' In this state, the worksheet can be unhidden via the user interface.
workbook.Worksheets("Sheet3").Visible = False
' #End Region ' #ShowHideWorksheet
See Also