Edit

Excel.Interfaces.CustomPropertyCollectionLoadOptions interface

  • Reference
Package:
excel

Contains the collection of custom properties.

Remarks

[ API set: ExcelApi 1.7 ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
key

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: The type of the value used for the custom property.
value

For EACH ITEM in the collection: 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

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

key

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: The type of the value used for the custom property.

type?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

value

For EACH ITEM in the collection: 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 ]