Excel.Interfaces.CustomPropertyLoadOptions interface

  • Reference
Package:
excel

Warning

This API is now deprecated.

Represents a custom property.

Remarks

[ API set: ExcelApi 1.7 ]

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

The key of the custom property. The key is limited to 255 characters outside of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms).
type

The type of the value used for the custom property.
value

The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms).

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

key

Warning

This API is now deprecated.

The key of the custom property. The key is limited to 255 characters outside of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms).

key?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

type

Warning

This API is now deprecated.

The type of the value used for the custom property.

type?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

value

Warning

This API is now deprecated.

The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms).

value?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]