Back to Devexpress

Worksheet.Unprotect(String) Method

officefileapi-devexpress-dot-spreadsheet-dot-worksheet-dot-unprotect-x28-system-dot-string-x29.md

latest4.1 KB
Original Source

Worksheet.Unprotect(String) Method

Removes protection from a worksheet.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
bool Unprotect(
    string password
)
vb
Function Unprotect(
    password As String
) As Boolean

Parameters

NameTypeDescription
passwordString

A string that specifies the password with which the worksheetis protected.

|

Returns

TypeDescription
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

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

// Remove worksheet protection (requires the 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;
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

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.

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

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

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

vb
If worksheet.IsProtected Then
    worksheet.Unprotect("password")
End If

See Also

Protect(String, WorksheetProtectionPermissions)

IsProtected

Worksheet Interface

Worksheet Members

DevExpress.Spreadsheet Namespace