Binding Object (JavaScript API for Excel)
Represents an Office.js binding that is defined in the workbook.
Properties
| Property | Type | Description | Req. Set |
|---|---|---|---|
| id | string | Represents binding identifier. Read-only. | 1.1 |
| type | string | Returns the type of the binding. Read-only. Possible values are: Range, Table, Text. | 1.1 |
See property access examples.
Relationships
None
Methods
| Method | Return Type | Description | Req. Set |
|---|---|---|---|
| delete() | void | Deletes the binding. | 1.3 |
| getRange() | Range | Returns the range represented by the binding. Will throw an error if binding is not of the correct type. | 1.1 |
| getTable() | Table | Returns the table represented by the binding. Will throw an error if binding is not of the correct type. | 1.1 |
| getText() | string | Returns the text represented by the binding. Will throw an error if binding is not of the correct type. | 1.1 |
Method Details
delete()
Deletes the binding.
Syntax
bindingObject.delete();
Parameters
None
Returns
void
getRange()
Returns the range represented by the binding. Will throw an error if binding is not of the correct type.
Syntax
bindingObject.getRange();
Parameters
None
Returns
Examples
Below example uses binding object to get the associated range.
Excel.run(function (ctx) {
var binding = ctx.workbook.bindings.getItemAt(0);
var range = binding.getRange();
range.load('cellCount');
return ctx.sync().then(function() {
console.log(range.cellCount);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
getTable()
Returns the table represented by the binding. Will throw an error if binding is not of the correct type.
Syntax
bindingObject.getTable();
Parameters
None
Returns
Examples
Excel.run(function (ctx) {
var binding = ctx.workbook.bindings.getItemAt(0);
var table = binding.getTable();
table.load('name');
return ctx.sync().then(function() {
console.log(table.name);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
getText()
Returns the text represented by the binding. Will throw an error if binding is not of the correct type.
Syntax
bindingObject.getText();
Parameters
None
Returns
string
Examples
Excel.run(function (ctx) {
var binding = ctx.workbook.bindings.getItemAt(0);
var text = binding.getText();
binding.load('text');
return ctx.sync().then(function() {
console.log(text);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
Property access examples
Excel.run(function (ctx) {
var binding = ctx.workbook.bindings.getItemAt(0);
binding.load('type');
return ctx.sync().then(function() {
console.log(binding.type);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});