Excel.FormatProtection class

Represents the format protection of a range object.

[ API set: ExcelApi 1.2 ]

Extends
OfficeExtension.ClientObject

Properties

formulaHidden

Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting.

[ API set: ExcelApi 1.2 ]

locked

Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting.

[ API set: ExcelApi 1.2 ]

Methods

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

toJSON()

Property Details

formulaHidden

Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting.

[ API set: ExcelApi 1.2 ]

formulaHidden: boolean;
Property Value
boolean

locked

Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting.

[ API set: ExcelApi 1.2 ]

locked: boolean;
Property Value
boolean

Method Details

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Excel.FormatProtection;
Parameters
option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns
Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.FormatProtection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.FormatProtection - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

toJSON()

toJSON(): Excel.Interfaces.FormatProtectionData;
Returns