WorksheetCopyOptions.OverwriteProtectionOnLockedWorksheet Property

Specifies whether to apply cell protection options of the source worksheet to cells in the protected destination worksheet.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

NuGet Packages: DevExpress.Spreadsheet.Core, DevExpress.WindowsDesktop.Spreadsheet.Core

Declaration

C#

public bool OverwriteProtectionOnLockedWorksheet { get; set; }

VB.NET

Public Property OverwriteProtectionOnLockedWorksheet As Boolean

Property Value

Type	Description
Boolean	true if cells in the protected destination worksheet have the same protection options as the source worksheet cells; overwise, false (default).

Remarks

If a worksheet where you paste data is protected, you can set the OverwriteProtectionOnLockedWorksheet property to true to copy cell protection settings from the source worksheet and apply them to cells in the destination worksheet.

C#

using DevExpress.Spreadsheet;
// ...

using (Workbook sourceWorkbook = new Workbook())
using (Workbook targetWorkbook = new Workbook())
{
    targetWorkbook.LoadDocument(@"Documents\Book1.xlsx");
    sourceWorkbook.LoadDocument(@"Documents\Book2.xlsx");
    // Add a new worksheet to the destination workbook.
    Worksheet targetSheet = targetWorkbook.Worksheets.Add("Sheet1_Copy");
    // Protect the worksheet.
    targetSheet.Protect("password", WorksheetProtectionPermissions.Default);
    // Specify copy options.
    var copyOptions = new WorksheetCopyOptions()
    {
        OverwriteProtectionOnLockedWorksheet = true
    };
    // Copy data from "Sheet1" in the source workbook
    // to the newly created worksheet in the destination workbook. 
    targetSheet.CopyFrom(sourceWorkbook.Worksheets["Sheet1"], copyOptions);
    targetWorkbook.SaveDocument("Result.xlsx");
}

VB.NET

Imports DevExpress.Spreadsheet
' ...

Using sourceWorkbook As New Workbook()
Using targetWorkbook As New Workbook()
    targetWorkbook.LoadDocument("Documents\Book1.xlsx")
    sourceWorkbook.LoadDocument("Documents\Book2.xlsx")
    ' Add a new worksheet to the destination workbook.
    Dim targetSheet As Worksheet = targetWorkbook.Worksheets.Add("Sheet1_Copy")
    ' Protect the worksheet.
    targetSheet.Protect("password", WorksheetProtectionPermissions.Default)
    ' Specify copy options.
    Dim copyOptions As New WorksheetCopyOptions() With {
      .OverwriteProtectionOnLockedWorksheet = True
      }
    ' Copy data from "Sheet1" in the source workbook
    ' to the newly created worksheet in the destination workbook. 
    targetSheet.CopyFrom(sourceWorkbook.Worksheets("Sheet1"), copyOptions)
    targetWorkbook.SaveDocument("Result.xlsx")
End Using
End Using