Excel.Binding class
Представляет привязку Office.js, которая определена в книге.
- Extends
Комментарии
Используется
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| id | Представляет идентификатор привязки. |
| type | Возвращает тип привязки. См. |
Методы
| delete() | Удаляет привязку. |
| get |
Возвращает представленный привязкой диапазон. Выдаст ошибку, если привязка имеет неправильный тип. |
| get |
Возвращает представленную привязкой таблицу. Выдаст ошибку, если привязка имеет неправильный тип. |
| get |
Возвращает представленный привязкой текст. Выдаст ошибку, если привязка имеет неправильный тип. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
События
| on |
Возникает при изменении данных или форматирования в привязке. |
| on |
Возникает при изменении выбранного содержимого в привязке.
Примечание. Если выделено несколько несмежных ячеек, |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
id
Представляет идентификатор привязки.
readonly id: string;Значение свойства
string
Комментарии
type
Возвращает тип привязки. См. Excel.BindingType дополнительные сведения.
readonly type: Excel.BindingType | "Range" | "Table" | "Text";Значение свойства
Excel.BindingType | "Range" | "Table" | "Text"
Комментарии
Сведения о методе
delete()
getRange()
Возвращает представленный привязкой диапазон. Выдаст ошибку, если привязка имеет неправильный тип.
getRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
const range = binding.getRange();
range.load('cellCount');
await context.sync();
console.log(range.cellCount);
});
getTable()
Возвращает представленную привязкой таблицу. Выдаст ошибку, если привязка имеет неправильный тип.
getTable(): Excel.Table;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
const table = binding.getTable();
table.load('name');
await context.sync();
console.log(table.name);
});
getText()
Возвращает представленный привязкой текст. Выдаст ошибку, если привязка имеет неправильный тип.
getText(): OfficeExtension.ClientResult<string>;Возвращаемое значение
OfficeExtension.ClientResult<string>
Комментарии
Примеры
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
const text = binding.getText();
binding.load('text');
await context.sync();
console.log(text);
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.Binding;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
Примеры
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
binding.load('type');
await context.sync();
console.log(binding.type);
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Binding;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Binding объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.BindingData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.BindingData;Возвращаемое значение
Сведения о событии
onDataChanged
Возникает при изменении данных или форматирования в привязке.
readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;Тип события
Комментарии
Примеры
// 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();
});
onSelectionChanged
Возникает при изменении выбранного содержимого в привязке.
Примечание. Если выделено несколько несмежных ячеек, Binding.onSelectionChanged отображаются сведения о строках и столбцах только для одной выбранной ячейки. Используется Worksheet.onSelectionChanged для нескольких выбранных диапазонов.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>;