Workbook.Protect(String, Boolean, Boolean) Method
Protects the structure and windows of a workbook.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Docs.v19.2.dll
Declaration
Parameters
Name | Type | Description |
---|---|---|
password | String | A string that specifies a password for the workbook. If an empty string is specified, the workbook can be unprotected without a password. |
lockStructure | Boolean | true, to lock the structure of the workbook (the position of the sheets); otherwise, false. |
lockWindows | Boolean | true, to prevent users from changing the position of worksheet windows; otherwise, false. |
Remarks
Locked structure of the workbook prevents users from adding or deleting worksheets, from hiding worksheets or displaying hidden worksheets. Locked windows option prevents users from freezing or unfreezing panes.
If the workbook is already protected (the Workbook.IsProtected property is true), the Protect method raises an exception.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-part-2-e4832
' Protect workbook structure (prevents users from adding or deleting worksheets
' or from displaying hidden worksheets).
workbook.BeginUpdate()
If Not workbook.IsProtected Then
workbook.Protect("password", True, False)
End If
workbook.Worksheets(0).Visible = False
Dim worksheet As Worksheet = workbook.Worksheets(1)
worksheet("D5").Value = "You are not allowed to add or delete a worksheet."
worksheet("D6").Value = "Hidden worksheets cannot be displayed."
workbook.EndUpdate()
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Protect(String, Boolean, Boolean) 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.