Workbook.Unprotect(String) Method

Removes protection from a workbook.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public bool Unprotect(
    string password
)

VB.NET

Public Function Unprotect(
    password As String
) As Boolean

Parameters

Name	Type	Description
password	String	A string that specifies the password with which the workbook is protected.

Returns

Type	Description
Boolean	true if protection is successfully removed; otherwise, false.

Remarks

If the workbook is not protected, the Unprotect method raises an exception. Use the Workbook.IsProtected property to check whether the workbook is already protected.

Example

View Example

ProtectionActions.cs

Worksheet worksheet = workbook.Worksheets["ProtectionSample"];
workbook.Worksheets.ActiveWorksheet = worksheet;

// Unprotect the workbook using a password.
if (workbook.IsProtected)
    workbook.Unprotect("password");
// Add a note.
worksheet["B2"].Value = "Workbook is unprotected. Workheets can be added, moved or deleted.";
worksheet.Visible = true;

ProtectionActions.vb

Dim worksheet As Worksheet = workbook.Worksheets("ProtectionSample")
workbook.Worksheets.ActiveWorksheet = worksheet

' Unprotect the workbook using a password.
If workbook.IsProtected Then
    workbook.Unprotect("password")
End If
' Add a note.
worksheet("B2").Value = "Workbook is unprotected. Workheets can be added, moved or deleted."
worksheet.Visible = True

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Unprotect(String) method.

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.

C#

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/CodeExamples/ProtectionActions.cs#L31

if (workbook.IsProtected)
    workbook.Unprotect("password");
// Add a note.

VB.NET

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/CodeExamples/ProtectionActions.vb#L26

' Unprotect the workbook.
If workbook.IsProtected Then workbook.Unprotect("password")
' Add a note.

Implements

Unprotect(String)