Protect Sheet
Protects or unprotects a worksheet with an optional password.
Behaviour
Risk: Low · Idempotent: Yes · Safe to retry: Yes · Recovery: Not replayed after a crash
Package Excel activities Velophex.Excel.Activities 0.7.1-rc.7 · Supported (Core profile) · type id velophex.excel.protectSheet
Properties#
Input#
Sheet#
Sheet · String · Required · Default: Not specified in package metadata
Worksheet name to protect/unprotect.
Workbook#
Workbook · ExcelWorkbookReference · Optional · Default: Not specified in package metadata
The Excel file to use. Empty uses the innermost enclosing Use Excel File; set it to the Reference As name of a Use Excel File to use that one.
Options#
Password#
Password · SecureString · Optional · Default: Not specified in package metadata · Sensitive
Optional password for protection, a SecureString.
Protect#
Protect · Boolean · Optional · Default: True
True to protect, false to unprotect.
Rules#
- Must be inside Use Excel File.
Retry and risk#
This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.
Every activity also has the engine's common properties: Timeout and Continue On Error.
Related activities#
- Append Range (Excel)
- Auto Fill
- Auto Fit Range
- Clear Range
- Copy Paste Range
- Copy Sheet
- Create Sheet
- Create Table
Generated from Velophex.Excel.Activities 0.7.1-rc.7. Category: Excel. Keywords: excel, workbook, xlsx, spreadsheet, sheet, protect, unprotect, password.
Properties
Input
Options
Rules
Retry and risk
Related activities