Excel.Interfaces.WorksheetProtectionData interface

Package:

excel

An interface describing the data returned by calling worksheetProtection.toJSON().

Properties

allowEditRanges	Specifies the AllowEditRangeCollection object found in this worksheet. This is a collection of AllowEditRange objects, which work with worksheet protection properties. When worksheet protection is enabled, an AllowEditRange object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.
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

allowEditRanges

Specifies the AllowEditRangeCollection object found in this worksheet. This is a collection of AllowEditRange objects, which work with worksheet protection properties. When worksheet protection is enabled, an AllowEditRange object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.

allowEditRanges?: Excel.Interfaces.AllowEditRangeData[];

Property Value

Excel.Interfaces.AllowEditRangeData[]

Remarks

[ API set: ExcelApiOnline 1.1 ]

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?: Excel.WorksheetProtectionOptions;

Property Value

Excel.WorksheetProtectionOptions

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?: Excel.WorksheetProtectionOptions;

Property Value

Excel.WorksheetProtectionOptions

Remarks

[ API set: ExcelApiOnline 1.1 ]