Edit this page
Available for: UI for ASP.NET AJAX | UI for ASP.NET MVC | UI for WPF | UI for WinForms | UI for Silverlight

Workbook Protection

In certain cases when you present a workbook to the users, you may want to prevent them from adding, removing, renaming or reordering sheets. This is where workbook protection comes at hand. The feature allows you to lock the structure of your workbook with or without a password. You can always unprotect the workbook as needed, however, you can also let the user remove the protection by entering the correct password. Once protection is removed, the user can add, remove, rename and reorder sheets.

Note that workbook protection in the context of the document model is an entirely user-oriented feature. When a workbook is protected, the UI will not allow the user to add, delete, reorder or rename sheets. That said, you as a developer have full access to the sheets collection of the workbook and can perform any modifications using code behind.

How to Protect a Workbook

To protect a workbook, use the Protect(string) method of the Workbook class. The method takes one string parameter that specifies the password used for enforcing protection.

Example 1 illustrates how to create a workbook from scratch and protect it using a password.

[C#] Example 1: Password-protect a Workbook

Workbook workbook = new Workbook();
workbook.Worksheets.Add();

workbook.Protect("telerik");

How to Unprotect a Workbook

Use the Unprotect(string) method of the Workbook class to remove the workbook protection. The method returns a Boolean value that indicates whether the workbook is successfully unprotected.

Example 2 demonstrates how to unprotect a workbook.

[C#] Example 2: Unprotect a Workbook

Workbook workbook = new Workbook();
workbook.Worksheets.Add();

workbook.Protect("telerik");

workbook.Unprotect("telerik");

See Also