openxlsx: protectWorkbook – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

protectWorkbook

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)

openxlsx

Read, Write and Edit xlsx Files

v4.2.3

MIT + file LICENSE

Authors

Philipp Schauberger [aut, cre], Alexander Walker [aut], Luca Braglia [ctb], Joshua Sturm [ctb]

Initial release

2020-10-26