Excel.BindingCollection class

Package:

excel

Represents the collection of all the binding objects that are part of the workbook.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.1 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
count	Returns the number of bindings in the collection.
items	Gets the loaded child items in this collection.

Methods

getItem(id)	Gets a binding object by ID.
getItemAt(index)	Gets a binding object based on its position in the items array.
load(options)	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(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
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.BindingCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.BindingCollectionData) 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

Excel.RequestContext

count

Returns the number of bindings in the collection.

readonly count: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]

items

Gets the loaded child items in this collection.

readonly items: Excel.Binding[];

Property Value

Excel.Binding[]

Method Details

getItem(id)

Gets a binding object by ID.

getItem(id: string): Excel.Binding;

Parameters

id

string

ID of the binding object to be retrieved.

Returns

Excel.Binding

Remarks

[ API set: ExcelApi 1.1 ]

Examples

async function onBindingDataChanged(eventArgs) {
    await Excel.run(async (context) => { 
        // Highlight the table related to the binding in orange to indicate data has been changed.
        context.workbook.bindings.getItem(eventArgs.binding.id).getTable().getDataBodyRange().format.fill.color = "Orange";
        await context.sync();
        
        console.log("The value in this table got changed!");
    });
}

getItemAt(index)

Gets a binding object based on its position in the items array.

getItemAt(index: number): Excel.Binding;

Parameters

index

number

Index value of the object to be retrieved. Zero-indexed.

Returns

Excel.Binding

Remarks

[ API set: ExcelApi 1.1 ]

Examples

await Excel.run(async (context) => { 
    const lastPosition = context.workbook.bindings.count - 1;
    const binding = context.workbook.bindings.getItemAt(lastPosition);
    binding.load('type')
    await context.sync();

    console.log(binding.type);
});

load(options)

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

load(options?: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection;

Parameters

options

Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.BindingCollection

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.BindingCollection;

Parameters

propertyNames

string | string[]

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

Returns

Excel.BindingCollection

Examples

await Excel.run(async (context) => { 
    const bindings = context.workbook.bindings;
    bindings.load('items');
    await context.sync();

    for (let i = 0; i < bindings.items.length; i++) {
        console.log(bindings.items[i].id);
    }
});

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.BindingCollection;

Parameters

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.BindingCollection

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.BindingCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.BindingCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.BindingCollectionData;

Returns

Excel.Interfaces.BindingCollectionData