Worksheet.IsProtected Property

Gets whether the worksheet is protected.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

bool IsProtected { get; }

VB.NET

ReadOnly Property IsProtected As Boolean

Property Value

Type	Description
Boolean	true, if the worksheet is protected; otherwise, false.

Remarks

Use the IsProtected property to check whether the worksheet is already protected before applying protection with the Worksheet.Protect method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IsProtected property.

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#L44

// Protect the worksheet with a password.
if (!worksheet.IsProtected)
    worksheet.Protect("password", WorksheetProtectionPermissions.Default);

winforms-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/ProtectionActions.cs#L38

// Protect a worksheet. Prevent users from making changes to worksheet elements.
if (!worksheet.IsProtected)
    worksheet.Protect("password", WorksheetProtectionPermissions.Default);

VB.NET

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

' Protect the worksheet with a password.
If Not worksheet.IsProtected Then worksheet.Protect("password", DevExpress.Spreadsheet.WorksheetProtectionPermissions.[Default])
' Add a note.

wpf-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/ProtectionActions.vb#L40

' Prevent users from making changes to worksheet elements
If Not worksheet.IsProtected Then
    worksheet.Protect("password", WorksheetProtectionPermissions.Default)

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/ProtectionActions.vb#L42

' Protect a worksheet. Prevent users from making changes to worksheet elements.
If Not worksheet.IsProtected Then
    worksheet.Protect("password", WorksheetProtectionPermissions.Default)