Worksheet.Unprotect(String) Method

Removes protection from a worksheet.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

bool Unprotect(
    string password
)

VB.NET

Function Unprotect(
    password As String
) As Boolean

Parameters

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

Returns

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

Remarks

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

Example

View Example

ProtectionActions.cs

Worksheet worksheet = workbook.Worksheets("ProtectionSample");
workbook.Worksheets.ActiveWorksheet = worksheet;

// Remove worksheet protection using a password.
if (worksheet.IsProtected) {
    worksheet.Unprotect("password");
}
// Add a note.
worksheet("B2").Value = "Worksheet is unprotected. You can edit and format cells.";
worksheet.Visible = true;

ProtectionActions.vb

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

' Remove worksheet protection using a password.
If worksheet.IsProtected Then
    worksheet.Unprotect("password")
End If
' Add a note.
worksheet("B2").Value = "Worksheet is unprotected. You can edit and format cells."
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#L61

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

VB.NET

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

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