Excel.CustomPropertyCollection class

Contains the collection of customProperty objects.

[ API set: ExcelApi 1.7 ]

Extends
OfficeExtension.ClientObject

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

items

Gets the loaded child items in this collection.

Methods

add(key, value)

Creates a new or sets an existing custom property.

[ API set: ExcelApi 1.7 ]

deleteAll()

Deletes all custom properties in this collection.

[ API set: ExcelApi 1.7 ]

getCount()

Gets the count of custom properties.

[ API set: ExcelApi 1.7 ]

getItem(key)

Gets a custom property object by its key, which is case-insensitive. Throws if the custom property does not exist.

[ API set: ExcelApi 1.7 ]

getItemOrNullObject(key)

Gets a custom property object by its key, which is case-insensitive. Returns a null object if the custom property does not exist.

[ API set: ExcelApi 1.7 ]

load(option)

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

load(propertyNames)

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

load(option)
toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.CustomPropertyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CustomPropertyCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

items

Gets the loaded child items in this collection.

readonly items: Excel.CustomProperty[];

Property Value

Excel.CustomProperty[]

Method Details

add(key, value)

Creates a new or sets an existing custom property.

[ API set: ExcelApi 1.7 ]

add(key: string, value: any): Excel.CustomProperty;

Parameters

key
string

Required. The custom property's key, which is case-insensitive.

value
any

Required. The custom property's value.

Returns

deleteAll()

Deletes all custom properties in this collection.

[ API set: ExcelApi 1.7 ]

deleteAll(): void;

Returns

void

getCount()

Gets the count of custom properties.

[ API set: ExcelApi 1.7 ]

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

getItem(key)

Gets a custom property object by its key, which is case-insensitive. Throws if the custom property does not exist.

[ API set: ExcelApi 1.7 ]

getItem(key: string): Excel.CustomProperty;

Parameters

key
string

The key that identifies the custom property object.

Returns

getItemOrNullObject(key)

Gets a custom property object by its key, which is case-insensitive. Returns a null object if the custom property does not exist.

[ API set: ExcelApi 1.7 ]

getItemOrNullObject(key: string): Excel.CustomProperty;

Parameters

key
string

Required. The key that identifies the custom property object.

Returns

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?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection;

Parameters

option
Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Returns

Remarks

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

load(option?: string | string[]): Excel.CustomPropertyCollection - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.CustomPropertyCollection - 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.CustomPropertyCollection - 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.

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.CustomPropertyCollection;

Parameters

propertyNames
string | string[]

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

Returns

load(option)

load(option?: OfficeExtension.LoadOption): Excel.CustomPropertyCollection;

Parameters

option
OfficeExtension.LoadOption

Returns

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.CustomPropertyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CustomPropertyCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.CustomPropertyCollectionData;

Returns