Поделиться через


Excel.BindingCollection class

Представляет коллекцию всех объектов привязки, включенных в книгу.

Extends

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

count

Возвращает число привязок в коллекции.

items

Получает загруженные дочерние элементы в этой коллекции.

Методы

add(range, bindingType, id)

Добавляет привязку к определенному объекту Range.

add(range, bindingTypeString, id)

Добавляет привязку к определенному объекту Range.

addFromNamedItem(name, bindingType, id)

Добавляет новую привязку с учетом именованного элемента в книге. Если именованный элемент ссылается на несколько областей, будет возвращена InvalidReference ошибка.

addFromNamedItem(name, bindingTypeString, id)

Добавляет новую привязку с учетом именованного элемента в книге. Если именованный элемент ссылается на несколько областей, будет возвращена InvalidReference ошибка.

addFromSelection(bindingType, id)

Добавляет новую привязку с учетом выделенного в настоящий момент фрагмента. Если выбор имеет несколько областей, будет возвращена InvalidReference ошибка.

addFromSelection(bindingTypeString, id)

Добавляет новую привязку с учетом выделенного в настоящий момент фрагмента. Если выбор имеет несколько областей, будет возвращена InvalidReference ошибка.

getCount()

Получает количество привязок в коллекции.

getItem(id)

Возвращает объект привязки по идентификатору.

getItemAt(index)

Возвращает объект привязки с учетом его положения в массиве элементов.

getItemOrNullObject(id)

Возвращает объект привязки по идентификатору. Если объект привязки не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.BindingCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.BindingCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

count

Возвращает число привязок в коллекции.

readonly count: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.Binding[];

Значение свойства

Сведения о методе

add(range, bindingType, id)

Добавляет привязку к определенному объекту Range.

add(range: Range | string, bindingType: Excel.BindingType, id: string): Excel.Binding;

Параметры

range

Excel.Range | string

Диапазон для привязки. Может быть Range объектом или строкой. Строка должна включать полный адрес, включающий имя листа.

bindingType
Excel.BindingType

Тип привязки. См. раздел Excel.BindingType.

id

string

Имя привязки.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.3 ]

add(range, bindingTypeString, id)

Добавляет привязку к определенному объекту Range.

add(range: Range | string, bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;

Параметры

range

Excel.Range | string

Диапазон для привязки. Может быть Range объектом или строкой. Строка должна включать полный адрес, включающий имя листа.

bindingTypeString

"Range" | "Table" | "Text"

Тип привязки. См. раздел Excel.BindingType.

id

string

Имя привязки.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.3 ]

addFromNamedItem(name, bindingType, id)

Добавляет новую привязку с учетом именованного элемента в книге. Если именованный элемент ссылается на несколько областей, будет возвращена InvalidReference ошибка.

addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string): Excel.Binding;

Параметры

name

string

Имя элемента, на основе которого создается привязка.

bindingType
Excel.BindingType

Тип привязки. См. раздел Excel.BindingType.

id

string

Имя привязки.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.3 ]

addFromNamedItem(name, bindingTypeString, id)

Добавляет новую привязку с учетом именованного элемента в книге. Если именованный элемент ссылается на несколько областей, будет возвращена InvalidReference ошибка.

addFromNamedItem(name: string, bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;

Параметры

name

string

Имя элемента, на основе которого создается привязка.

bindingTypeString

"Range" | "Table" | "Text"

Тип привязки. См. раздел Excel.BindingType.

id

string

Имя привязки.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.3 ]

addFromSelection(bindingType, id)

Добавляет новую привязку с учетом выделенного в настоящий момент фрагмента. Если выбор имеет несколько областей, будет возвращена InvalidReference ошибка.

addFromSelection(bindingType: Excel.BindingType, id: string): Excel.Binding;

Параметры

bindingType
Excel.BindingType

Тип привязки. См. раздел Excel.BindingType.

id

string

Имя привязки.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.3 ]

addFromSelection(bindingTypeString, id)

Добавляет новую привязку с учетом выделенного в настоящий момент фрагмента. Если выбор имеет несколько областей, будет возвращена InvalidReference ошибка.

addFromSelection(bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;

Параметры

bindingTypeString

"Range" | "Table" | "Text"

Тип привязки. См. раздел Excel.BindingType.

id

string

Имя привязки.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.3 ]

getCount()

Получает количество привязок в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.4 ]

getItem(id)

Возвращает объект привязки по идентификатору.

getItem(id: string): Excel.Binding;

Параметры

id

string

Идентификатор получаемого объекта привязки.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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

Значение индекса получаемого объекта. Используется нулевой индекс.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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)

Возвращает объект привязки по идентификатору. Если объект привязки не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(id: string): Excel.Binding;

Параметры

id

string

Идентификатор получаемого объекта привязки.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.4 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

options

Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

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" с мелкими копиями всех загруженных свойств из элементов коллекции.

toJSON(): Excel.Interfaces.BindingCollectionData;

Возвращаемое значение