Interface ICellProtection

The protection format of a cell: whether it stays editable, and whether it shows its formula, while its sheet is protected.

Remarks

Part of the style, so it travels with the format — copy, paste, fill and named styles carry it, and clearing formats resets it.
Only consulted while the sheet is protected. ICell.isEditAllowed and ICell.isFormulaHidden combine it with the sheet's protection and its unlocked ranges.

interface ICellProtection {
    isICellProtection: true;
    isAlwaysUnlocked(): boolean;
    isShowFormulas(): boolean;
    setAlwaysUnlocked(
        alwaysUnlocked: boolean | null,
        options?: UpdateOptions,
    ): ICellProtection;
    setShowFormulas(
        showFormulas: boolean | null,
        options?: UpdateOptions,
    ): ICellProtection;
    toJSON(): ICellProtection.JSON;
}

Index

Properties

isICellProtection

Methods

isAlwaysUnlocked isShowFormulas setAlwaysUnlocked setShowFormulas toJSON

Properties

`Readonly`isICellProtection

isICellProtection: true

For runtime type checking.

Methods

isAlwaysUnlocked

isAlwaysUnlocked(): boolean
Returns true if the cell stays editable when its sheet is protected.

Returns boolean
Remarks
- This is Excel's Locked format, inverted.
- It never asks for a password, even inside a password-protected unlocked range. An unlocked range is the other way to make a cell editable; either one is enough.
Default Value
```
false
```

isShowFormulas

isShowFormulas(): boolean
Returns true if the cell's formula stays visible on a protected sheet that hides formulas.

Returns boolean
Remarks
- An exception, like isAlwaysUnlocked: a formula shows when the sheet (ISheetProtection.isShowFormulasAllowed) or the cell allows it, so this only matters while the sheet hides them.
- A hidden formula reads as no formula (ICell.getFormula is null), but it still calculates and is still saved with the workbook. It is a view rule, not secrecy.
Default Value
```
false
```

setAlwaysUnlocked

setAlwaysUnlocked(
alwaysUnlocked: boolean | null,
options?: UpdateOptions,
): ICellProtection
Sets whether the cell stays editable when its sheet is protected.
Parameters
- alwaysUnlocked: boolean | null
  true to keep the cell editable. null to clear.
- Optionaloptions: UpdateOptions
Returns ICellProtection

setShowFormulas

setShowFormulas(
showFormulas: boolean | null,
options?: UpdateOptions,
): ICellProtection
Sets whether the cell's formula stays visible on a protected sheet that hides formulas.
Parameters
- showFormulas: boolean | null
  true to keep the formula visible. null to clear.
- Optionaloptions: UpdateOptions
Returns ICellProtection

toJSON

toJSON(): ICellProtection.JSON

Returns ICellProtection.JSON