Workbook.IsProtected Property

Indicates whether a workbook is protected.

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

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v24.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public bool IsProtected { get; }

VB.NET

Public ReadOnly Property IsProtected As Boolean

Property Value

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

Remarks

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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#L16

// Protect workbook structure with a password.
if (!workbook.IsProtected)
    workbook.Protect("password", true, false);

VB.NET

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

' Protect workbook structure with a password.
If Not workbook.IsProtected Then workbook.Protect("password", True, False)
' Add a note.

Implements

IsProtected