Office.TableBinding interface

Obtiene el número de columnas de TableBinding, como un valor entero.

columnCount: number;

Valor de propiedad

Ejemplos

function showBindingColumnCount() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Column: " + asyncResult.value.columnCount);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

True, si la tabla tiene encabezados; de lo contrario, false.

hasHeaders: boolean;

Valor de propiedad

Ejemplos

function showBindingHasHeaders() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Binding has headers: " + asyncResult.value.hasHeaders);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Obtiene el número de filas de TableBinding, como un valor entero.

rowCount: number;

Valor de propiedad

Comentarios

Al insertar una tabla vacía seleccionando una sola fila en Excel en el escritorio y Excel en la web (con Tabla en la pestaña Insertar), ambas aplicaciones de Office crean una sola fila de encabezados seguida de una sola fila en blanco. Sin embargo, si el script del complemento crea un enlace para esta tabla recién insertada (por ejemplo, mediante el método Office.Bindings.addFromSelectionAsync) y, a continuación, comprueba el valor de la propiedad rowCount, el valor devuelto variará en función de si la hoja de cálculo está abierta en Excel en el escritorio o en Excel en la web.

• En Excel en el escritorio (es decir, Windows y Mac), rowCount devolverá 0 (la fila en blanco que sigue a los encabezados no se cuenta).

• En Excel en la web, rowCount devolverá 1 (se cuenta la fila en blanco que sigue a los encabezados).

Para solucionar esta diferencia en su script, puede comprobar si rowCount == 1 y, en caso afirmativo, comprobar si la fila contiene todas las cadenas vacías.

Ejemplos

function showBindingRowCount() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Rows: " + asyncResult.value.rowCount);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Agrega los datos especificados a la tabla como columnas adicionales.

addColumnsAsync(tableData: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

Para agregar una o más columnas que especifiquen los valores de los datos y encabezados, pase un objeto TableData como parámetro de datos. Para agregar una o varias columnas a partir únicamente de los datos especificados, envíe una matriz de matrices ("matriz") como parámetro data.

El éxito o error de una operación addColumnsAsync es atómico. Es decir, toda la acción de adición de columnas tiene que ser correcta o se deshará la acción completamente (y la propiedad AsyncResult.status que se devuelve a la devolución de llamada informará de un fallo):

• Cada fila de la matriz que se pasa como argumento de datos debe tener el mismo número de filas que la tabla que se está actualizando. Si no, fallará toda la acción.

• Cada fila y celda de la matriz debe agregar correctamente esa fila o celda a la tabla en las columnas recién agregadas. Si, por cualquier motivo, no se define alguna de las filas o las celdas, fallará toda la acción.

• Si pasa un objeto TableData como argumento de datos, el número de filas de encabezado debe coincidir con el de la tabla que se está actualizando.

Comentario adicional para Excel en la web: el número total de celdas del objeto TableData pasado al parámetro de datos no puede superar las 20 000 en una sola llamada a este método.

Ejemplos

// The following example adds a single column with three rows to a bound table with the id "myTable"
// by passing a TableData object as the data argument of the addColumnsAsync method. To succeed,
// the table being updated must have three rows.

// Add a column to a binding of type table by passing a TableData object.
function addColumns() {
    const myTable = new Office.TableData();
    myTable.headers = [["Cities"]];
    myTable.rows = [["Berlin"], ["Roma"], ["Tokyo"]];

    Office.context.document.bindings.getByIdAsync("myTable", function (result) {
        result.value.addColumnsAsync(myTable);
    });
}

// The following example adds a single column with three rows to a bound table with the id myTable
// by passing an array of arrays ("matrix") as the data argument of the addColumnsAsync method.
// To succeed, the table being updated must have three rows.

// Add a column to a binding of type table by passing an array of arrays.
function addColumns() {
    const myTable = [["Berlin"], ["Roma"], ["Tokyo"]];

    Office.context.document.bindings.getByIdAsync("myTable", function (result) {
        result.value.addColumnsAsync(myTable);
    });
}

Agrega los datos especificados a la tabla como columnas adicionales.

addColumnsAsync(tableData: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

Para agregar una o más columnas que especifiquen los valores de los datos y encabezados, pase un objeto TableData como parámetro de datos. Para agregar una o varias columnas a partir únicamente de los datos especificados, envíe una matriz de matrices ("matriz") como parámetro data.

El éxito o error de una operación addColumnsAsync es atómico. Es decir, toda la acción de adición de columnas tiene que ser correcta o se deshará la acción completamente (y la propiedad AsyncResult.status que se devuelve a la devolución de llamada informará de un fallo):

• Cada fila de la matriz que se pasa como argumento de datos debe tener el mismo número de filas que la tabla que se está actualizando. Si no, fallará toda la acción.

• Cada fila y celda de la matriz debe agregar correctamente esa fila o celda a la tabla en las columnas recién agregadas. Si, por cualquier motivo, no se define alguna de las filas o las celdas, fallará toda la acción.

• Si pasa un objeto TableData como argumento de datos, el número de filas de encabezado debe coincidir con el de la tabla que se está actualizando.

Comentario adicional para Excel en la web: el número total de celdas del objeto TableData pasado al parámetro de datos no puede superar las 20 000 en una sola llamada a este método.

Agrega los datos especificados a la tabla como filas adicionales.

addRowsAsync(rows: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

El éxito o el error de una operación addRowsAsync es atómico. Es decir, toda la acción de adición de columnas tiene que ser correcta o se deshará la acción completamente (y la propiedad AsyncResult.status que se devuelve a la devolución de llamada informará de un fallo):

• Cada fila de la matriz que se pasa como argumento data debe tener el mismo número de columnas que la tabla que se está actualizando. Si no, fallará toda la acción.

• Cada columna y celda de la matriz debe agregar correctamente esa columna o celda a la tabla en las filas recién agregadas. Si no se puede establecer ninguna columna o celda por cualquier motivo, se producirá un error en toda la operación.

• Si pasa un objeto TableData como argumento de datos, el número de filas de encabezado debe coincidir con el de la tabla que se está actualizando.

Comentario adicional para Excel en la web: el número total de celdas del objeto TableData pasado al parámetro de datos no puede superar las 20 000 en una sola llamada a este método.

Ejemplos

function addRowsToTable() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        const binding = asyncResult.value;
        binding.addRowsAsync([["6", "k"], ["7", "j"]]);
    });
}

Agrega los datos especificados a la tabla como filas adicionales.

addRowsAsync(rows: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

El éxito o el error de una operación addRowsAsync es atómico. Es decir, toda la acción de adición de columnas tiene que ser correcta o se deshará la acción completamente (y la propiedad AsyncResult.status que se devuelve a la devolución de llamada informará de un fallo):

• Cada fila de la matriz que se pasa como argumento data debe tener el mismo número de columnas que la tabla que se está actualizando. Si no, fallará toda la acción.

• Cada columna y celda de la matriz debe agregar correctamente esa columna o celda a la tabla en las filas recién agregadas. Si no se puede establecer ninguna columna o celda por cualquier motivo, se producirá un error en toda la operación.

• Si pasa un objeto TableData como argumento de datos, el número de filas de encabezado debe coincidir con el de la tabla que se está actualizando.

Comentario adicional para Excel en la web: el número total de celdas del objeto TableData pasado al parámetro de datos no puede superar las 20 000 en una sola llamada a este método.

Borra el formato en la tabla enlazada.

clearFormatsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

Vea Dar formato a tablas en complementos para Excel para obtener más información.

Ejemplos

// The following example shows how to clear the formatting of the bound table with an ID of "myBinding":
Office.select("bindings#myBinding").clearFormatsAsync();

Borra el formato en la tabla enlazada.

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

Parámetros

Devoluciones

Comentarios

Vea Dar formato a tablas en complementos para Excel para obtener más información.

Elimina todas las filas que no son de encabezado y sus valores de la tabla, desplazando correctamente para la aplicación de Office.

deleteAllDataValuesAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

En Excel, si la tabla no tiene una fila de encabezado, este método suprimirá la propia tabla.

Ejemplos

function deleteAllRowsFromTable() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        const binding = asyncResult.value;
        binding.deleteAllDataValuesAsync();
    });
}

Elimina todas las filas que no son de encabezado y sus valores de la tabla, desplazando correctamente para la aplicación de Office.

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

Parámetros

Devoluciones

Comentarios

En Excel, si la tabla no tiene una fila de encabezado, este método suprimirá la propia tabla.

Obtiene el formato de los elementos especificados de la tabla.

getFormatsAsync(cellReference?: any, formats?: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult< Array<{ cells: any, format: any}>>) => void): void;

Parámetros

Devoluciones

Comentarios

Estructura de formato devuelta

Cada objeto JavaScript de la matriz de valores devueltos tiene este formato: {cells:{ cell_range }, format:{ format_definition }}

La cells: propiedad especifica el intervalo que desea formatear mediante uno de los siguientes valores.

Rangos admitidos en la propiedad cells

La format: propiedad especifica valores que corresponden a un subconjunto de la configuración disponible en el cuadro de diálogo Formato de celdas en Excel (Abra el menú contextual (haga clic con el botón derecho o haga clic y mantenga presionado) y, a continuación, seleccione Formato de celdas oFormato>de inicio>celdas).

Obtiene el formato de los elementos especificados de la tabla.

getFormatsAsync(cellReference?: any, formats?: any[], callback?: (result: AsyncResult< Array<{ cells: any, format: any}>>) => void): void;

Parámetros

Devoluciones

Comentarios

Estructura de formato devuelta

Cada objeto JavaScript de la matriz de valores devueltos tiene este formato: {cells:{ cell_range }, format:{ format_definition }}

La cells: propiedad especifica el intervalo que desea formatear mediante uno de los siguientes valores.

Rangos admitidos en la propiedad cells

La format: propiedad especifica valores que corresponden a un subconjunto de la configuración disponible en el cuadro de diálogo Formato de celdas en Excel (Abra el menú contextual (haga clic con el botón derecho o haga clic y mantenga presionado) y, a continuación, seleccione Formato de celdas oFormato>de inicio>celdas).

Establece el formato de los elementos y datos especificados de la tabla.

setFormatsAsync(cellFormat: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

Especificar el parámetro cellFormat

Use el parámetro cellFormat para establecer o cambiar los valores de formato de celda, como ancho, alto, fuente, fondo, alineación, etc. El valor que se pasa como parámetro cellFormat es una matriz que contiene una lista de uno o varios objetos JavaScript que especifican qué celdas se van a dirigir (cells:) y los formatos (format:) que se van a aplicar a ellos.

Cada objeto JavaScript de la matriz cellFormat tiene este formato: {cells:{ cell_range }, format:{ format_definition }}

La cells: propiedad especifica el intervalo que desea formatear mediante uno de los siguientes valores.

Rangos admitidos en la propiedad cells

La format: propiedad especifica valores que corresponden a un subconjunto de la configuración disponible en el cuadro de diálogo Formato de celdas en Excel (Abra el menú contextual (haga clic con el botón derecho o haga clic y mantenga presionado) y, a continuación, seleccione Formato de celdas oFormato>de inicio>celdas).

El valor de la format: propiedad se especifica como una lista de uno o varios pares de nombre de propiedad- valor en un literal de objeto de JavaScript. El nombre de propiedad especifica el nombre de la propiedad de formato que se va a establecer, y valor especifica el valor de dicha propiedad. Se pueden especificar varios valores para un formato concreto, como el color y el tamaño de una fuente.

A continuación, puede consultar tres ejemplos de valores de la propiedad format::

//Set cells: font color to green and size to 15 points.

format: {fontColor : "green", fontSize : 15}

//Set cells: border to dotted blue.

format: {borderStyle: "dotted", borderColor: "blue"}

//Set cells: background to red and alignment to centered.

format: {backgroundColor: "red", alignHorizontal: "center"}

Puede especificar formatos de número especificando la cadena de formato de número "code" en la numberFormat: propiedad . Las cadenas de formato numérico que puede especificar se corresponden con las que se pueden establecer en Excel mediante la categoría Personalizada en la pestaña Número del cuadro de diálogo Formato de celdas. El ejemplo siguiente muestra cómo dar formato a un número como porcentaje con dos decimales:

format: {numberFormat:"0.00%"}

Para obtener más detalles, vea Cómo crear un formato de número personalizado.

Para establecer el formato en las tablas al escribir datos, use los parámetros opcionales tableOptions y cellFormat de los Document.setSelectedDataAsync métodos o TableBinding.setDataAsync .

Establecer el formato con los parámetros opcionales de los Document.setSelectedDataAsync métodos y TableBinding.setDataAsync solo funciona para establecer el formato al escribir datos la primera vez. Para realizar cambios de formato después de escribir datos, use los métodos siguientes.

• Para actualizar el formato de celda, como el color de fuente y el estilo, use el TableBinding.setFormatsAsync método (este método).

• Para actualizar las opciones de tabla, como filas en bandas y botones de filtro, use el TableBinding.setTableOptions método .

• Para borrar el formato, use el TableBinding.clearFormats método .

Para obtener más detalles y ejemplos, vea Cómo dar formato a tablas en complementos para Excel.

Ejemplos

// Specifying a single target
// The following example shows a cellFormat value that sets the font color of the header row to red.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: Office.Table.Headers, format: {fontColor: "red"}}], 
    function (asyncResult){});

// Specifying multiple targets
// The setFormatsAsync method can support formatting multiple targets within the bound table in a 
// single function call. To do that, you pass a list of objects in the cellFormat array 
// for each target that you want to format.
// For example, the following line of code will set the font color of the first row yellow, 
// and the fourth cell in the third row to have a white border and bold text.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: {row: 1}, format: {fontColor: "yellow"}}, 
        {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}], 
    function (asyncResult){});

// Additional remarks for Excel Online
// The number of formatting groups passed to the cellFormat parameter can't exceed 100. 
// A single formatting group consists of a set of formatting applied to a specified range of cells. 
// For example, the following call passes two formatting groups to cellFormat.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: {row: 1}, format: {fontColor: "yellow"}}, 
        {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}], 
    function (asyncResult){});

Establece el formato de los elementos y datos especificados de la tabla.

setFormatsAsync(cellFormat: any[], callback?: (result: AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

Especificar el parámetro cellFormat

Use el parámetro cellFormat para establecer o cambiar los valores de formato de celda, como ancho, alto, fuente, fondo, alineación, etc. El valor que se pasa como parámetro cellFormat es una matriz que contiene una lista de uno o varios objetos JavaScript que especifican qué celdas se van a dirigir (cells:) y los formatos (format:) que se van a aplicar a ellos.

Cada objeto JavaScript de la matriz cellFormat tiene este formato: {cells:{ cell_range }, format:{ format_definition }}

La cells: propiedad especifica el intervalo que desea formatear mediante uno de los siguientes valores.

Rangos admitidos en la propiedad cells

La format: propiedad especifica valores que corresponden a un subconjunto de la configuración disponible en el cuadro de diálogo Formato de celdas en Excel (Abra el menú contextual (haga clic con el botón derecho o haga clic y mantenga presionado) y, a continuación, seleccione Formato de celdas oFormato>de inicio>celdas).

El valor de la format: propiedad se especifica como una lista de uno o varios pares de nombre de propiedad- valor en un literal de objeto de JavaScript. El nombre de propiedad especifica el nombre de la propiedad de formato que se va a establecer, y valor especifica el valor de dicha propiedad. Se pueden especificar varios valores para un formato concreto, como el color y el tamaño de una fuente.

A continuación, puede consultar tres ejemplos de valores de la propiedad format::

//Set cells: font color to green and size to 15 points.

format: {fontColor : "green", fontSize : 15}

//Set cells: border to dotted blue.

format: {borderStyle: "dotted", borderColor: "blue"}

//Set cells: background to red and alignment to centered.

format: {backgroundColor: "red", alignHorizontal: "center"}

Puede especificar formatos de número especificando la cadena de formato de número "code" en la numberFormat: propiedad . Las cadenas de formato numérico que puede especificar se corresponden con las que se pueden establecer en Excel mediante la categoría Personalizada en la pestaña Número del cuadro de diálogo Formato de celdas. El ejemplo siguiente muestra cómo dar formato a un número como porcentaje con dos decimales:

format: {numberFormat:"0.00%"}

Para obtener más detalles, vea Cómo crear un formato de número personalizado.

Para establecer el formato en las tablas al escribir datos, use los parámetros opcionales tableOptions y cellFormat de los Document.setSelectedDataAsync métodos o TableBinding.setDataAsync .

Establecer el formato con los parámetros opcionales de los Document.setSelectedDataAsync métodos y TableBinding.setDataAsync solo funciona para establecer el formato al escribir datos la primera vez. Para realizar cambios de formato después de escribir datos, use los métodos siguientes.

• Para actualizar el formato de celda, como el color de fuente y el estilo, use el TableBinding.setFormatsAsync método (este método).

• Para actualizar las opciones de tabla, como filas en bandas y botones de filtro, use el TableBinding.setTableOptions método .

• Para borrar el formato, use el TableBinding.clearFormats método .

Para obtener más detalles y ejemplos, vea Cómo dar formato a tablas en complementos para Excel.

Actualiza las opciones de formato de tabla en la tabla enlazada.

setTableOptionsAsync(tableOptions: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

Conjunto de requisitos: no en un conjunto

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

Ejemplos

// The following example shows how to:
// 1. Create an object literal that specifies the table formatting options to update on the bound table.
// 2. Call setTableOptions on a previously bound table (with an id of myBinding) passing the object
//    with formatting setting as the tableOptions parameter.
function updateTableFormatting(){
    const tableOptions = {bandedRows: true, filterButton: false, style: "TableStyleMedium3"}; 

    Office.select("bindings#myBinding").setTableOptionsAsync(tableOptions, function(asyncResult){});
}

Actualiza las opciones de formato de tabla en la tabla enlazada.

setTableOptionsAsync(tableOptions: any, callback?: (result: AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

Conjunto de requisitos: no en un conjunto

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