Office.Binding interface

获取与绑定关联的 Document 对象。

document: Office.Document;

属性值

示例

Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
    write(asyncResult.value.document.url);
});

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

在同一 Office.Document 对象中的绑定之间唯一标识此绑定的字符串。

id: string;

属性值

示例

Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
    write(asyncResult.value.id);
});

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

获取绑定的类型。

type: Office.BindingType;

属性值

示例

Office.context.document.bindings.getByIdAsync("MyBinding", function (asyncResult) { 
    write(asyncResult.value.type); 
}) 

// Function that writes to a div with id='message' on the page. 
function write(message){ 
    document.getElementById('message').innerText += message;  
}

将事件处理程序添加到指定 Office.EventType 的 对象。 支持的 EventType 为 Office.EventType.BindingDataChanged 和 Office.EventType.BindingSelectionChanged。

addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult<void>) => void): void;

参数

返回

注解

要求集： BindingEvents

只要每个事件处理程序函数的名称唯一，就可以为指定的 eventType 添加多个事件处理程序。

将事件处理程序添加到指定 Office.EventType 的 对象。 支持的 EventType 为 Office.EventType.BindingDataChanged 和 Office.EventType.BindingSelectionChanged。

addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult<void>) => void): void;

参数

返回

注解

要求集： BindingEvents

只要每个事件处理程序函数的名称唯一，就可以为指定的 eventType 添加多个事件处理程序。

示例

// The following code sample calls the select function of the Office object to access the binding
// with ID "MyBinding", and then calls the addHandlerAsync method to add a handler function 
// for the bindingDataChanged event of that binding.
function addEventHandlerToBinding() {
    Office.select("bindings#MyBinding").addHandlerAsync(
        Office.EventType.BindingDataChanged, onBindingDataChanged);
}

function onBindingDataChanged(eventArgs) {
    write("Data has changed in binding: " + eventArgs.binding.id);
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

// To add an event handler for the BindingSelectionChanged event of a binding, 
// use the addHandlerAsync method of the Binding object.
// The event handler receives an argument of type BindingSelectionChangedEventArgs.
function addEventHandlerToBinding() {
    Office.select("bindings#MyBinding").addHandlerAsync(
        Office.EventType.BindingSelectionChanged, onBindingSelectionChanged);
}

function onBindingSelectionChanged(eventArgs) {
    write(eventArgs.binding.id + " has been selected.");
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

返回绑定中包含的数据。

getDataAsync<T>(options?: GetBindingDataOptions, callback?: (result: AsyncResult<T>) => void): void;

参数

返回

注解

要求集：

• 使用 Office.CoercionType.Html) 时 htmlCoercion (

• MatrixBindings

• 使用 Office.CoercionType.Matrix) 时，MatrixCoercion (

• 使用 Office.CoercionType.Ooxml) 时 OoxmlCoercion (

• TableBindings

• 使用 Office.CoercionType.Table) 时的 TableCoercion (

• TextBindings

• 使用 Office.CoercionType.Text) 时 TextCoercion (

从 MatrixBinding 或 TableBinding 调用时，如果 (指定了可选的 startRow、startColumn、rowCount 和 columnCount 参数，并且它们指定了连续且有效的范围) ，则 getDataAsync 方法将返回绑定值的子集。

返回绑定中包含的数据。

getDataAsync<T>(callback?: (result: AsyncResult<T>) => void): void;

参数

返回

注解

要求集：

• 使用 Office.CoercionType.Html) 时 htmlCoercion (

• MatrixBindings

• 使用 Office.CoercionType.Matrix) 时，MatrixCoercion (

• 使用 Office.CoercionType.Ooxml) 时 OoxmlCoercion (

• TableBindings

• 使用 Office.CoercionType.Table) 时的 TableCoercion (

• TextBindings

• 使用 Office.CoercionType.Text) 时 TextCoercion (

从 MatrixBinding 或 TableBinding 调用时，如果 (指定了可选的 startRow、startColumn、rowCount 和 columnCount 参数，并且它们指定了连续且有效的范围) ，则 getDataAsync 方法将返回绑定值的子集。

示例

function showBindingData() {
    Office.select("bindings#MyBinding").getDataAsync(function (asyncResult) {
        write(asyncResult.value)
    });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

// There is an important difference in behavior between using the "table" and "matrix" coercionType with the
// Binding.getDataAsync method, with respect to data formatted with header rows, as shown in the following
// two examples. These code examples show event handler functions for the Binding.SelectionChanged event.

// If you specify the "table" coercionType, the TableData.rows property ( result.value.rows in the following
// code example) returns an array that contains only the body rows of the table. So, its 0th row will be the
// first non-header row in the table.
function selectionChanged(evtArgs) { 
    Office.select("bindings#TableTranslate").getDataAsync(
        { coercionType: 'table', 
          startRow: evtArgs.startRow, 
          startCol: 0, 
          rowCount: 1, 
          columnCount: 1 },  
        function (result) { 
            if (result.status == 'succeeded') { 
                write("Image to find: " + result.value.rows[0][0]); 
            } 
            else 
                write(result.error.message); 
    }); 
}     
// Function that writes to a div with id='message' on the page. 
function write(message){ 
    document.getElementById('message').innerText += message; 
}

// However, if you specify the "matrix" coercionType, result.value in the following code example returns an array
// that contains the table header in the 0th row. If the table header contains multiple rows, then these are all
// included in the result.value matrix as separate rows before the table body rows are included.
function selectionChanged(evtArgs) { 
    Office.select("bindings#TableTranslate").getDataAsync(
        { coercionType: 'matrix', 
          startRow: evtArgs.startRow, 
          startCol: 0, 
          rowCount: 1, 
          columnCount: 1 },  
        function (result) { 
            if (result.status == 'succeeded') { 
                write("Image to find: " + result.value[1][0]); 
            } 
            else 
                write(result.error.message); 
    }); 
}     
// Function that writes to a div with id='message' on the page. 
function write(message){ 
    document.getElementById('message').innerText += message; 
}

从绑定移除指定事件类型的指定处理程序。

removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;

参数

返回

注解

要求集： BindingEvents

从绑定移除指定事件类型的指定处理程序。

removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult<void>) => void): void;

参数

返回

注解

要求集： BindingEvents

示例

function removeEventHandlerFromBinding() {
    Office.select("bindings#MyBinding").removeHandlerAsync(
        Office.EventType.BindingDataChanged, {handler:onBindingDataChanged});
}

将数据写入指定的绑定对象表示的文档的绑定部分。

setDataAsync(data: TableData | any, options?: SetBindingDataOptions, callback?: (result: AsyncResult<void>) => void): void;

参数

返回

注解

要求集：

• 使用 Office.CoercionType.Html) 时 htmlCoercion (

• MatrixBindings

• 使用 Office.CoercionType.Matrix) 时，MatrixCoercion (

• 使用 Office.CoercionType.Ooxml) 时 OoxmlCoercion (

• TableBindings

• 使用 Office.CoercionType.Table) 时的 TableCoercion (

• TextBindings

• 使用 Office.CoercionType.Text) 时 TextCoercion (

为数据传递的值包含要在绑定中写入的数据。 传递的值的类型决定将要写入的内容，如下表中所示。

此外，这些特定于应用程序的操作在将数据写入绑定时适用。 对于Word，指定的数据将写入绑定，如下所示。

对于 Excel，指定的数据将写入绑定，如下所示。

对于Excel web 版：

• 在对此方法的单个调用中，传递给数据参数的值中的单元格总数不能超过 20,000。

• 传递给 cellFormat 参数的格式设置组数不能超过 100。 每个格式设置组由应用于特定单元格范围的一组格式组成。

在其他所有情况下，都会返回错误。

如果指定了可选的 startRow 和 startColumn 参数，并且它们指定了有效的范围，setDataAsync 方法将在表或矩阵绑定的子集中写入数据。

在传递给 setDataAsync 方法的回调函数中，您可以使用 AsyncResult 对象的属性返回以下信息。

将数据写入指定的绑定对象表示的文档的绑定部分。

setDataAsync(data: TableData | any, callback?: (result: AsyncResult<void>) => void): void;

参数

返回

注解

要求集：

• 使用 Office.CoercionType.Html) 时 htmlCoercion (

• MatrixBindings

• 使用 Office.CoercionType.Matrix) 时，MatrixCoercion (

• 使用 Office.CoercionType.Ooxml) 时 OoxmlCoercion (

• TableBindings

• 使用 Office.CoercionType.Table) 时的 TableCoercion (

• TextBindings

• 使用 Office.CoercionType.Text) 时 TextCoercion (

为数据传递的值包含要在绑定中写入的数据。 传递的值的类型决定将要写入的内容，如下表中所示。

此外，这些特定于应用程序的操作在将数据写入绑定时适用。 对于Word，指定的数据将写入绑定，如下所示。

对于 Excel，指定的数据将写入绑定，如下所示。

对于Excel web 版：

• 在对此方法的单个调用中，传递给数据参数的值中的单元格总数不能超过 20,000。

• 传递给 cellFormat 参数的格式设置组数不能超过 100。 每个格式设置组由应用于特定单元格范围的一组格式组成。

在其他所有情况下，都会返回错误。

如果指定了可选的 startRow 和 startColumn 参数，并且它们指定了有效的范围，setDataAsync 方法将在表或矩阵绑定的子集中写入数据。

在传递给 setDataAsync 方法的回调函数中，您可以使用 AsyncResult 对象的属性返回以下信息。

示例

function setBindingData() {
    Office.select("bindings#MyBinding").setDataAsync('Hello World!', function (asyncResult) { });
}

// Specifying the optional coercionType parameter lets you specify the kind of data you want to write to a binding.
// For example, in Word if you want to write HTML to a text binding, you can specify the coercionType parameter 
// as "html" as shown in the following example, which uses HTML <b> tags to make "Hello" bold.
function writeHtmlData() {
    Office.select("bindings#myBinding").setDataAsync(
        "<b>Hello</b> World!", {coercionType: "html"}, function (asyncResult) {
        if (asyncResult.status == "failed") {
            write('Error: ' + asyncResult.error.message);
        }
    });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

// In this example, the call to setDataAsync passes the data parameter as an array of arrays
// (to create a single column of three rows), and specifies the data structure with the 
// coercionType parameter as a "matrix".
function writeBoundDataMatrix() {
    Office.select("bindings#myBinding").setDataAsync(
        [['Berlin'],['Munich'],['Duisburg']],{ coercionType: "matrix" }, function (asyncResult) {
        if (asyncResult.status == "failed") {
            write('Error: ' + asyncResult.error.message);
        } else {
            write('Bound data: ' + asyncResult.value);
        }
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

// In the writeBoundDataTable function in this example, the call to setDataAsync passes the data parameter 
// as a TableData object (to write three columns and three rows), and specifies the data structure
// with the coercionType parameter as a "table".

// In the updateTableData function, the call to setDataAsync again passes the data parameter as a TableData object,
// but as a single column with a new header and three rows, to update the values in the last column 
// of the table created with the writeBoundDataTable function. The optional zero-based startColumn parameter 
// is specified as 2 to replace the values in the third column of the table.
function writeBoundDataTable() {
    // Create a TableData object.
    const myTable = new Office.TableData();
    myTable.headers = ['First Name', 'Last Name', 'Grade'];
    myTable.rows = [['Kim', 'Abercrombie', 'A'], ['Junmin','Hao', 'C'],['Toni','Poe','B']];

    // Set myTable in the binding.
    Office.select("bindings#myBinding").setDataAsync(myTable, { coercionType: "table" }, 
        function (asyncResult) {
            if (asyncResult.status == Office.AsyncResultStatus.Failed) {
                write('Error: '+ asyncResult.error.message);
        } else {
            write('Bound data: ' + asyncResult.value);
        }
    });
}

// Replace last column with different data.
function updateTableData() {
    const newTable = new Office.TableData();
    newTable.headers = ["Gender"];
    newTable.rows = [["M"],["M"],["F"]];
    Office.select("bindings#myBinding").setDataAsync(newTable, { coercionType: "table", startColumn:2 }, 
        function (asyncResult) {
            if (asyncResult.status == Office.AsyncResultStatus.Failed) {
                write('Error: '+ asyncResult.error.message);
        } else {
            write('Bound data: ' + asyncResult.value);
        }     
    });   
}

// In this example, the following call passes two formatting groups to cellFormat.
Office.select("bindings#myBinding").setDataAsync([['Berlin'],['Munich'],['Duisburg']],
  {cellFormat:[{cells: {row: 1}, format: {fontColor: "yellow"}}, 
      {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}]}, 
  function (asyncResult){});