Excel.Interfaces.AllowEditRangeCollectionLoadOptions interface

  • Reference
Package:
excel

Warning

This API is now deprecated.

Represents the set of AllowEditRange objects found in a worksheet. AllowEditRange objects 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.

Remarks

[ API set: ExcelApiOnline 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
address

For EACH ITEM in the collection: Specifies the range associated with the object. Worksheet protection must be disabled or paused for this method to work properly. If worksheet protection is enabled and not paused, this method throws an AccessDenied error and fails to set the range.
isPasswordProtected

For EACH ITEM in the collection: Specifies if the object is password protected.
title

For EACH ITEM in the collection: Specifies the title of the object. Worksheet protection must be disabled or paused for this method to work properly. If worksheet protection is enabled and not paused, this method throws an AccessDenied error and fails to set the title. If there is already an existing AllowEditRange with the same string, or if the string is null or empty (""), then this method throws an InvalidArgument error and fails to set the title.

Property Details

$all

Warning

This API is now deprecated.

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

address

Warning

This API is now deprecated.

For EACH ITEM in the collection: Specifies the range associated with the object. Worksheet protection must be disabled or paused for this method to work properly. If worksheet protection is enabled and not paused, this method throws an AccessDenied error and fails to set the range.

address?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiOnline 1.1 ]

isPasswordProtected

Warning

This API is now deprecated.

For EACH ITEM in the collection: Specifies if the object is password protected.

isPasswordProtected?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiOnline 1.1 ]

title

Warning

This API is now deprecated.

For EACH ITEM in the collection: Specifies the title of the object. Worksheet protection must be disabled or paused for this method to work properly. If worksheet protection is enabled and not paused, this method throws an AccessDenied error and fails to set the title. If there is already an existing AllowEditRange with the same string, or if the string is null or empty (""), then this method throws an InvalidArgument error and fails to set the title.

title?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiOnline 1.1 ]