Excel.Binding class

  • Ссылка
Пакет:
excel

Представляет привязку Office.js, которая определена в книге.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

context

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

Представляет идентификатор привязки.
type

Возвращает тип привязки. Дополнительные сведения см. в этой Excel.BindingType статье.

Методы

delete()

Удаляет привязку.
getRange()

Возвращает представленный привязкой диапазон. Если привязка не соответствует правильному типу, вызовет ошибку.
getTable()

Возвращает представленную привязкой таблицу. Если привязка не соответствует правильному типу, вызовет ошибку.
getText()

Возвращает представленный привязкой текст. Если привязка не соответствует правильному типу, вызовет ошибку.
load(options)

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

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

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

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

События

onDataChanged

Возникает при изменении данных или форматирования в привязке.
onSelectionChanged

Происходит при изменении выбранного содержимого в привязке.

Примечание*. Если выбрано несколько, нечетких ячеек, Binding.onSelectionChanged сообщается только о строке и столбце для одного выделения. Используется Worksheet.onSelectionChanged для нескольких выбранных диапазонов.

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

context

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

context: RequestContext;

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

Excel.RequestContext

id

Представляет идентификатор привязки.

readonly id: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

type

Возвращает тип привязки. Дополнительные сведения см. в этой Excel.BindingType статье.

readonly type: Excel.BindingType | "Range" | "Table" | "Text";

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

Excel.BindingType | "Range" | "Table" | "Text"

Комментарии

[ Набор API: ExcelApi 1.1 ]

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

delete()

Удаляет привязку.

delete(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.3 ]

getRange()

Возвращает представленный привязкой диапазон. Если привязка не соответствует правильному типу, вызовет ошибку.

getRange(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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;

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

Excel.Table

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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>

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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;

Параметры

options
Excel.Interfaces.BindingLoadOptions

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

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

Excel.Binding

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.Binding

Примеры

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

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

Excel.Binding

toJSON()

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

toJSON(): Excel.Interfaces.BindingData;

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

Excel.Interfaces.BindingData

Сведения о событии

onDataChanged

Возникает при изменении данных или форматирования в привязке.

readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>

Комментарии

[ Набор API: ExcelApi 1.2 ]

Примеры

// 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>;

Тип события

OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>

Комментарии

[ Набор API: ExcelApi 1.2 ]