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;

パラメーター

戻り値

注釈

要件セット:

• HtmlCoercion (使用時 Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (使用時 Office.CoercionType.Matrix)

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

• TableBindings

• TableCoercion (使用時 Office.CoercionType.Table)

• TextBindings

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

MatrixBinding または TableBinding から呼び出されると、getDataAsync メソッドは、オプションの startRow、startColumn、rowCount、columnCount パラメーターが指定されている場合 (および連続した有効な範囲を指定する) 場合、バインドされた値のサブセットを返します。

バインド内に含まれるデータを返します。

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

パラメーター

戻り値

注釈

要件セット:

• HtmlCoercion (使用時 Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (使用時 Office.CoercionType.Matrix)

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

• TableBindings

• TableCoercion (使用時 Office.CoercionType.Table)

• TextBindings

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

MatrixBinding または TableBinding から呼び出されると、getDataAsync メソッドは、オプションの startRow、startColumn、rowCount、columnCount パラメーターが指定されている場合 (および連続した有効な範囲を指定する) 場合、バインドされた値のサブセットを返します。

例

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;

パラメーター

戻り値

注釈

要件セット:

• HtmlCoercion (使用時 Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (使用時 Office.CoercionType.Matrix)

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

• TableBindings

• TableCoercion (使用時 Office.CoercionType.Table)

• TextBindings

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

データに渡される値には、バインディングで書き込まれるデータが含まれます。 次の表に示されるように、渡された値の種類により、書き込まれる内容が決まります。

また、バインドにデータを書き込むときに、次のアプリケーション固有の処理が適用されます。 Wordの場合、指定したデータは次のようにバインドに書き込まれます。

Excel の場合、指定したデータは次のようにバインドに書き込まれます。

Excel on the webの場合:

• データ パラメーターに渡される値のセルの合計数は、このメソッドの 1 回の呼び出しで 20,000 を超えることはできません。

• cellFormat パラメーターに渡される書式設定グループの数は、100 を超えることはできません。 1 つの書式設定グループは、指定のセル範囲に適用される書式設定のセットから構成されます。

上記以外の場合は、エラーが返されます。

setDataAsync メソッドは、オプションの startRow パラメーターと startColumn パラメーターを指定し、有効な範囲を指定した場合、テーブルまたはマトリックス バインドのサブセットにデータを書き込みます。

setDataAsync メソッドに渡されたコールバック関数で、AsyncResult オブジェクトのプロパティを使用して次の情報を戻せます。

指定されたバインド オブジェクトで表されるドキュメントのバインド セクションにデータを書き込みます。

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

パラメーター

戻り値

注釈

要件セット:

• HtmlCoercion (使用時 Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (使用時 Office.CoercionType.Matrix)

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

• TableBindings

• TableCoercion (使用時 Office.CoercionType.Table)

• TextBindings

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

データに渡される値には、バインディングで書き込まれるデータが含まれます。 次の表に示されるように、渡された値の種類により、書き込まれる内容が決まります。

また、バインドにデータを書き込むときに、次のアプリケーション固有の処理が適用されます。 Wordの場合、指定したデータは次のようにバインドに書き込まれます。

Excel の場合、指定したデータは次のようにバインドに書き込まれます。

Excel on the webの場合:

• データ パラメーターに渡される値のセルの合計数は、このメソッドの 1 回の呼び出しで 20,000 を超えることはできません。

• cellFormat パラメーターに渡される書式設定グループの数は、100 を超えることはできません。 1 つの書式設定グループは、指定のセル範囲に適用される書式設定のセットから構成されます。

上記以外の場合は、エラーが返されます。

setDataAsync メソッドは、オプションの startRow パラメーターと startColumn パラメーターを指定し、有効な範囲を指定した場合、テーブルまたはマトリックス バインドのサブセットにデータを書き込みます。

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){});