Back to Devexpress

WriteProtectionOptions.IsPasswordProtected Property

officefileapi-devexpress-dot-spreadsheet-dot-writeprotectionoptions-e1cf4377.md

latest2.4 KB
Original Source

WriteProtectionOptions.IsPasswordProtected Property

Indicates whether a workbook is write-protected.

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
bool IsPasswordProtected { get; }
vb
ReadOnly Property IsPasswordProtected As Boolean

Property Value

TypeDescription
Boolean

true if the document requires a password for write access; otherwise, false.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to IsPasswordProtected
DocumentSettings

.WriteProtection .IsPasswordProtected

|

Remarks

The following example demonstrates how to remove protection from a write-protected document:

csharp
using (Workbook workbook = new Workbook())
{
    workbook.LoadDocument("WriteProtectedDocument.xlsx");
    RemoveWriteProtection(workbook);
}
// ...

private void RemoveWriteProtection(Workbook workbook)
{
    if (workbook.DocumentSettings.WriteProtection.IsPasswordProtected)
        workbook.DocumentSettings.WriteProtection.ClearPassword();
}
vb
Using workbook As New Workbook()
    workbook.LoadDocument("WriteProtectedDocument.xlsx")
    RemoveWriteProtection(workbook)
End Using
' ...

Private Sub RemoveWriteProtection(workbook As Workbook)
    If workbook.DocumentSettings.WriteProtection.IsPasswordProtected Then
        workbook.DocumentSettings.WriteProtection.ClearPassword()
    End If
End Sub

See Also

WriteProtectionOptions Interface

WriteProtectionOptions Members

DevExpress.Spreadsheet Namespace