Excel.BindingCollection class
表示属于工作簿的所有绑定对象的集合。
方法
| add(range, binding |
将新的 binding 对象添加到特定区域。 |
| add(range, binding |
将新的 binding 对象添加到特定区域。 |
| add |
根据工作簿中的命名项添加新的 binding 对象。 如果命名项引用了多个区域，则将返回该 |
| add |
根据工作簿中的命名项添加新的 binding 对象。 如果命名项引用了多个区域，则将返回该 |
| add |
根据当前选择的内容添加新的 binding 对象。 如果所选区域有多个区域， |
| add |
根据当前选择的内容添加新的 binding 对象。 如果所选区域有多个区域， |
| get |
获取集合中的绑定数量。 |
| get |
按 ID 获取绑定对象。 |
| get |
根据其在项目数组中的位置获取绑定对象。 |
| get |
按 ID 获取绑定对象。 如果绑定对象不存在，则此方法返回其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
count
items
方法详细信息
add(range, bindingType, id)
将新的 binding 对象添加到特定区域。
add(range: Range | string, bindingType: Excel.BindingType, id: string): Excel.Binding;参数
- range
-
Excel.Range | string
要将绑定绑定到的范围。 可以是 Range 对象或字符串。 如果是字符串，必须包含完整地址，包括工作表名称
- bindingType
- Excel.BindingType
绑定的类型。 请参阅 Excel.BindingType。
- id
-
string
绑定的名称。
返回
注解
add(range, bindingType, id)
将新的 binding 对象添加到特定区域。
add(range: Range | string, bindingType: "Range" | "Table" | "Text", id: string): Excel.Binding;参数
- range
-
Excel.Range | string
要将绑定绑定到的范围。 可以是 Range 对象或字符串。 如果是字符串，必须包含完整地址，包括工作表名称
- bindingType
-
"Range" | "Table" | "Text"
绑定的类型。 请参阅 Excel.BindingType。
- id
-
string
绑定的名称。
返回
注解
addFromNamedItem(name, bindingType, id)
根据工作簿中的命名项添加新的 binding 对象。 如果命名项引用了多个区域，则将返回该 InvalidReference 错误。
addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string): Excel.Binding;参数
- name
-
string
从中创建绑定的名称。
- bindingType
- Excel.BindingType
绑定的类型。 请参阅 Excel.BindingType。
- id
-
string
绑定的名称。
返回
注解
addFromNamedItem(name, bindingType, id)
根据工作簿中的命名项添加新的 binding 对象。 如果命名项引用了多个区域，则将返回该 InvalidReference 错误。
addFromNamedItem(name: string, bindingType: "Range" | "Table" | "Text", id: string): Excel.Binding;参数
- name
-
string
从中创建绑定的名称。
- bindingType
-
"Range" | "Table" | "Text"
绑定的类型。 请参阅 Excel.BindingType。
- id
-
string
绑定的名称。
返回
注解
addFromSelection(bindingType, id)
根据当前选择的内容添加新的 binding 对象。 如果所选区域有多个区域， InvalidReference 则将返回错误。
addFromSelection(bindingType: Excel.BindingType, id: string): Excel.Binding;参数
- bindingType
- Excel.BindingType
绑定的类型。 请参阅 Excel.BindingType。
- id
-
string
绑定的名称。
返回
注解
addFromSelection(bindingType, id)
根据当前选择的内容添加新的 binding 对象。 如果所选区域有多个区域， InvalidReference 则将返回错误。
addFromSelection(bindingType: "Range" | "Table" | "Text", id: string): Excel.Binding;参数
- bindingType
-
"Range" | "Table" | "Text"
绑定的类型。 请参阅 Excel.BindingType。
- id
-
string
绑定的名称。
返回
注解
getCount()
获取集合中的绑定数量。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getItem(id)
按 ID 获取绑定对象。
getItem(id: string): Excel.Binding;参数
- id
-
string
要检索的绑定对象的 ID。
返回
注解
示例
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)
根据其在项目数组中的位置获取绑定对象。
getItemAt(index: number): Excel.Binding;参数
- index
-
number
要检索的对象的索引值。 从零开始编制索引。
返回
注解
示例
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);
});
getItemOrNullObject(id)
按 ID 获取绑定对象。 如果绑定对象不存在，则此方法返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(id: string): Excel.Binding;参数
- id
-
string
要检索的绑定对象的 ID。
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.BindingCollection;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
示例
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)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.BindingCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.BindingCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.BindingCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
toJSON(): Excel.Interfaces.BindingCollectionData;