Excel.BindingCollection class

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

Свойства

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

Методы

add(range, bindingType, id)	Добавляет привязку к определенному объекту Range.
add(range, bindingType, id)	Добавляет привязку к определенному объекту Range.
addFromNamedItem(name, bindingType, id)	Добавляет новую привязку с учетом именованного элемента в книге. Если именованный элемент ссылается на несколько областей, ошибка `InvalidReference` будет возвращена.
addFromNamedItem(name, bindingType, id)	Добавляет новую привязку с учетом именованного элемента в книге. Если именованный элемент ссылается на несколько областей, ошибка `InvalidReference` будет возвращена.
addFromSelection(bindingType, id)	Добавляет новую привязку с учетом выделенного в настоящий момент фрагмента. Если выделенный фрагмент содержит несколько областей, будет возвращена `InvalidReference` ошибка.
addFromSelection(bindingType, id)	Добавляет новую привязку с учетом выделенного в настоящий момент фрагмента. Если выделенный фрагмент содержит несколько областей, будет возвращена `InvalidReference` ошибка.
getCount()	Получает количество привязок в коллекции.
getItem(id)	Возвращает объект привязки по идентификатору.
getItemAt(index)	Возвращает объект привязки с учетом его положения в массиве элементов.
getItemOrNullObject(id)	Возвращает объект привязки по идентификатору. Если объекта привязки не существует, этот метод возвращает объект со свойством `isNullObject` , установленным в `true`значение . Дополнительные сведения см. в разделе Методы и свойства *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;

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

Excel.RequestContext

count

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

readonly count: number;

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

number

items

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

readonly items: Excel.Binding[];

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

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

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

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

Excel.Binding

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-changed.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");    
    const salesTable = sheet.tables.getItem("SalesTable");
    const salesByQuarterBinding = context.workbook.bindings.add(salesTable.getRange(), "Table", "SalesByQuarter");
    salesByQuarterBinding.onDataChanged.add(onSalesDataChanged);

    console.log("The data changed handler is registered.");

    await context.sync();
});

add(range, bindingType, id)

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

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

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

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

Excel.Binding

addFromNamedItem(name, bindingType, id)

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

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

Параметры

name: string

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

bindingType: Excel.BindingType

Тип привязки. См.Excel.BindingType

id: string

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

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

Excel.Binding

addFromNamedItem(name, bindingType, id)

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

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

Параметры

name: string

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

bindingType: "Range" | "Table" | "Text"

Тип привязки. См.Excel.BindingType

id: string

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

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

Excel.Binding

addFromSelection(bindingType, id)

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

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

Параметры

bindingType: Excel.BindingType

Тип привязки. См.Excel.BindingType

id: string

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

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

Excel.Binding

addFromSelection(bindingType, id)

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

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

Параметры

bindingType: "Range" | "Table" | "Text"

Тип привязки. См.Excel.BindingType

id: string

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

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

Excel.Binding

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

getItem(id)

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

getItem(id: string): Excel.Binding;

Параметры

id: string

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

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

Excel.Binding

Примеры

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

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

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

Excel.Binding

Примеры

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)

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

getItemOrNullObject(id: string): Excel.Binding;

Параметры

id: string

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

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

Excel.Binding

load(options)

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

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

Параметры

options: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.BindingCollection

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

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

Excel.BindingCollection

Примеры

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 через запятую, указывающая свойства навигации для загрузки.

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

Excel.BindingCollection

toJSON()

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

toJSON(): Excel.Interfaces.BindingCollectionData;

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

Excel.Interfaces.BindingCollectionData

Комментарии

Используется

Свойства

Методы

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

context

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

count

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

Комментарии

items

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

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

add(range, bindingType, id)

Параметры

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

Комментарии

Примеры

add(range, bindingType, id)

Параметры

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

Комментарии

addFromNamedItem(name, bindingType, id)

Параметры

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

Комментарии

addFromNamedItem(name, bindingType, id)

Параметры

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

Комментарии

addFromSelection(bindingType, id)

Параметры

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

Комментарии

addFromSelection(bindingType, id)

Параметры

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

Комментарии

getCount()

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

Комментарии

getItem(id)

Параметры

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

Комментарии

Примеры

getItemAt(index)

Параметры

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

Комментарии

Примеры

getItemOrNullObject(id)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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

Обратная связь