R: Protect a workbook from modifications

protectWorkbook {openxlsx} | R Documentation

## Protect a workbook from modifications

### Description

Protect or unprotect a workbook from modifications by the user in the graphical user interface. Replaces an existing protection.

### Usage

    protectWorkbook(
      wb,
      protect = TRUE,
      password = NULL,
      lockStructure = FALSE,
      lockWindows = FALSE
    )

### Arguments

`wb` | A workbook object
`protect` | Whether to protect or unprotect the sheet (default=TRUE)
`password` | (optional) password required to unprotect the workbook
`lockStructure` | Whether the workbook structure should be locked
`lockWindows` | Whether the window position of the spreadsheet should be locked

### Author(s)

Reinhold Kainhofer

### Examples

    wb <- createWorkbook()
    addWorksheet(wb, "S1")
    protectWorkbook(wb, protect = TRUE, password = "Password", lockStructure = TRUE)
    ## Not run:
    saveWorkbook(wb, "WorkBook_Protection.xlsx", overwrite = TRUE)

    ## End(Not run)
    # Remove the protection
    protectWorkbook(wb, protect = FALSE)
    ## Not run:
    saveWorkbook(wb, "WorkBook_Protection_unprotected.xlsx", overwrite = TRUE)

    ## End(Not run)

[Package openxlsx version 4.2.4 Index]