How to: Protect a Workbook

• Jan 23, 2019

The following code protects workbook structure with a password (“password”), preventing end-users from adding or deleting worksheets, and from displaying hidden worksheets.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-part-2-e4832

ProtectionActions.cs

// Protect workbook structure (prevents users from adding or deleting worksheets
// or from displaying hidden worksheets).
workbook.BeginUpdate();
if (!workbook.IsProtected)
    workbook.Protect("password", true, false);
workbook.Worksheets[0].Visible = false;
Worksheet worksheet = workbook.Worksheets[1];
worksheet["D5"].Value = "You are not allowed to add or delete a worksheet.";
worksheet["D6"].Value = "Hidden worksheets cannot be displayed.";
workbook.EndUpdate();

ProtectionActions.vb

' Protect workbook structure (prevents users from adding or deleting worksheets
' or from displaying hidden worksheets).
workbook.BeginUpdate()
If Not workbook.IsProtected Then
    workbook.Protect("password", True, False)
End If
workbook.Worksheets(0).Visible = False
Dim worksheet As Worksheet = workbook.Worksheets(1)
worksheet("D5").Value = "You are not allowed to add or delete a worksheet."
worksheet("D6").Value = "Hidden worksheets cannot be displayed."
workbook.EndUpdate()

Use the IWorkbook.Unprotect method to remove protection.

When protection is applied programmatically, end-users can invoke the Protect Workbook Dialog to remove protection.