Office.Binding interface

Obtenga el objeto Document asociado al enlace.

document: Office.Document;

Valor de propiedad

Ejemplos

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

Cadena que identifica de forma única este enlace entre los enlaces del mismo objeto Office.Document .

id: string;

Valor de propiedad

Ejemplos

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

Obtiene el tipo del enlace.

type: Office.BindingType;

Valor de propiedad

Ejemplos

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

Agrega un controlador de eventos al objeto para el objeto Office.EventType especificado. Los eventTypes admitidos son Office.EventType.BindingDataChanged y Office.EventType.BindingSelectionChanged.

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

Parámetros

Devoluciones

Comentarios

Conjunto de requisitos: BindingEvents

Puede agregar varios controladores de eventos para el eventType especificado siempre y cuando el nombre de cada función de controlador de eventos sea único.

Agrega un controlador de eventos al objeto para el objeto Office.EventType especificado. Los eventTypes admitidos son Office.EventType.BindingDataChanged y Office.EventType.BindingSelectionChanged.

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

Parámetros

Devoluciones

Comentarios

Conjunto de requisitos: BindingEvents

Puede agregar varios controladores de eventos para el eventType especificado siempre y cuando el nombre de cada función de controlador de eventos sea único.

Ejemplos

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

Devuelve los datos que contiene el enlace.

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

Parámetros

Devoluciones

Comentarios

Conjuntos de requisitos:

• HtmlCoercion (cuando se usa Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (cuando se usa Office.CoercionType.Matrix)

• OoxmlCoercion (cuando se usa Office.CoercionType.Ooxml)

• TableBindings

• TableCoercion (cuando se usa Office.CoercionType.Table)

• TextBindings

• TextCoercion (cuando se usa Office.CoercionType.Text)

Cuando se llama desde MatrixBinding o TableBinding, el método getDataAsync devolverá un subconjunto de los valores enlazados si se especifican los parámetros opcionales startRow, startColumn, rowCount y columnCount (y especifican un intervalo contiguo y válido).

Devuelve los datos que contiene el enlace.

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

Parámetros

Devoluciones

Comentarios

Conjuntos de requisitos:

• HtmlCoercion (cuando se usa Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (cuando se usa Office.CoercionType.Matrix)

• OoxmlCoercion (cuando se usa Office.CoercionType.Ooxml)

• TableBindings

• TableCoercion (cuando se usa Office.CoercionType.Table)

• TextBindings

• TextCoercion (cuando se usa Office.CoercionType.Text)

Cuando se llama desde MatrixBinding o TableBinding, el método getDataAsync devolverá un subconjunto de los valores enlazados si se especifican los parámetros opcionales startRow, startColumn, rowCount y columnCount (y especifican un intervalo contiguo y válido).

Ejemplos

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

Quita del enlace el controlador que se especifica para el tipo de evento determinado.

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

Parámetros

Devoluciones

Comentarios

Conjunto de requisitos: BindingEvents

Quita del enlace el controlador que se especifica para el tipo de evento determinado.

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

Parámetros

Devoluciones

Comentarios

Conjunto de requisitos: BindingEvents

Ejemplos

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

Escribe datos en la sección enlazada del documento que representa el objeto de enlace que se ha especificado.

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

Parámetros

Devoluciones

Comentarios

Conjuntos de requisitos:

• HtmlCoercion (cuando se usa Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (cuando se usa Office.CoercionType.Matrix)

• OoxmlCoercion (cuando se usa Office.CoercionType.Ooxml)

• TableBindings

• TableCoercion (cuando se usa Office.CoercionType.Table)

• TextBindings

• TextCoercion (cuando se usa Office.CoercionType.Text)

El valor pasado para los datos contiene los datos que se van a escribir en el enlace. El tipo de valor que se pasa determina qué se escribirá, tal como se describe en la tabla siguiente.

Estas acciones específicas de aplicaciones también se pueden realizar al escribir datos en un enlace. Para Word, los datos especificados se escriben en el enlace como se indica a continuación.

Para Excel, los datos especificados se escriben en el enlace como se indica a continuación.

Para Excel en la web:

• El número total de celdas del valor pasado al parámetro data no puede superar las 20 000 en una sola llamada a este método.

• El número de grupos de formato pasados al parámetro cellFormat no puede superar los 100. Un único grupo de formato consta de un conjunto de formato aplicado a un rango de celdas especificado.

En todos los casos restantes, se devolverá un error.

El método setDataAsync escribirá datos en un subconjunto de un enlace de tabla o matriz si se especifican los parámetros startRow e startColumn opcionales y especifican un intervalo válido.

En la función de devolución de llamada que se ha pasado al método setDataAsync, puede usar las propiedades del objeto AsyncResult para devolver la siguiente información.

Escribe datos en la sección enlazada del documento que representa el objeto de enlace que se ha especificado.

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

Parámetros

Devoluciones

Comentarios

Conjuntos de requisitos:

• HtmlCoercion (cuando se usa Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (cuando se usa Office.CoercionType.Matrix)

• OoxmlCoercion (cuando se usa Office.CoercionType.Ooxml)

• TableBindings

• TableCoercion (cuando se usa Office.CoercionType.Table)

• TextBindings

• TextCoercion (cuando se usa Office.CoercionType.Text)

El valor pasado para los datos contiene los datos que se van a escribir en el enlace. El tipo de valor que se pasa determina qué se escribirá, tal como se describe en la tabla siguiente.

Estas acciones específicas de aplicaciones también se pueden realizar al escribir datos en un enlace. Para Word, los datos especificados se escriben en el enlace como se indica a continuación.

Para Excel, los datos especificados se escriben en el enlace como se indica a continuación.

Para Excel en la web:

• El número total de celdas del valor pasado al parámetro data no puede superar las 20 000 en una sola llamada a este método.

• El número de grupos de formato pasados al parámetro cellFormat no puede superar los 100. Un único grupo de formato consta de un conjunto de formato aplicado a un rango de celdas especificado.

En todos los casos restantes, se devolverá un error.

El método setDataAsync escribirá datos en un subconjunto de un enlace de tabla o matriz si se especifican los parámetros startRow e startColumn opcionales y especifican un intervalo válido.

En la función de devolución de llamada que se ha pasado al método setDataAsync, puede usar las propiedades del objeto AsyncResult para devolver la siguiente información.

Ejemplos

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