Edit

Share via

Excel.Interfaces.WorksheetCustomPropertyLoadOptions interface

Package:
excel

Represents a worksheet-level custom property.

Remarks

[ API set: ExcelApi 1.12 ]

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).
key

Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255 characters (larger values will cause an InvalidArgument error to be thrown.)
value

Specifies the value of the custom property.

Property Details

$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).

$all?: boolean;

Property Value

boolean

key

Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255 characters (larger values will cause an InvalidArgument error to be thrown.)

key?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.12 ]

value

Specifies the value of the custom property.

value?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.12 ]