Excel.Interfaces.WorksheetProtectionLoadOptions interface

Package:

excel

Represents the protection of a worksheet object.

Remarks

[ API set: ExcelApi 1.2 ]

Properties

$all	Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
canPauseProtection	Specifies if protection can be paused for this worksheet.
isPasswordProtected	Specifies if the sheet is password protected.
isPaused	Specifies if worksheet protection is paused.
options	Specifies the protection options for the worksheet.
protected	Specifies if the worksheet is protected.
savedOptions	Specifies the protection options saved in the worksheet. This will return the same WorksheetProtectionOptions object regardless of the worksheet protection state.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

canPauseProtection

Specifies if protection can be paused for this worksheet.

canPauseProtection?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiOnline 1.1 ]

isPasswordProtected

Specifies if the sheet is password protected.

isPasswordProtected?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiOnline 1.1 ]

isPaused

Specifies if worksheet protection is paused.

isPaused?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiOnline 1.1 ]

options

Specifies the protection options for the worksheet.

options?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.2 ]

protected

Specifies if the worksheet is protected.

protected?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.2 ]

savedOptions

Specifies the protection options saved in the worksheet. This will return the same WorksheetProtectionOptions object regardless of the worksheet protection state.

savedOptions?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiOnline 1.1 ]