Excel.TableRowCollection class

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Devuelve el número de filas de la tabla.

readonly count: number;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.TableRow[];

Valor de propiedad

Agrega una o más filas a la tabla. El objeto devuelto será el superior de las filas recién agregadas.

Tenga en cuenta que, a diferencia de los intervalos o columnas, que se ajustarán si se agregan nuevas filas o columnas antes que ellos, un TableRow objeto representa la ubicación física de la fila de tabla, pero no los datos. Es decir, si los datos están ordenados o si se agregan nuevas filas, una fila de tabla seguirá apuntando al índice para el que se creó.

add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 para agregar una sola fila; 1.4 permite agregar varias filas; 1.15 para agregar alwaysInsert parámetro. ]

Ejemplos

await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    const values = [["Sample", "Values", "For", "New", "Row"]];
    const row = tables.getItem("Table1").rows.add(null, values);
    row.load('index');
    await context.sync();
    
    console.log(row.index);
});

Obtiene el número de filas de la tabla.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Obtiene una fila en función de su posición en la colección.

Tenga en cuenta que, a diferencia de los intervalos o columnas, que se ajustarán si se agregan nuevas filas o columnas antes que ellos, un TableRow objeto representa la ubicación física de la fila de tabla, pero no los datos. Es decir, si los datos están ordenados o si se agregan nuevas filas, una fila de tabla seguirá apuntando al índice para el que se creó.

getItemAt(index: number): Excel.TableRow;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => {
    const tablerow = context.workbook.tables.getItem('Table1').rows.getItemAt(0);
    tablerow.load('values');
    await context.sync();
    console.log(tablerow.values);
});

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Ejemplos

await Excel.run(async (context) => { 
    const tablerows = context.workbook.tables.getItem('Table1').rows;
    tablerows.load('items');
    await context.sync();
    
    console.log("tablerows Count: " + tablerows.count);
    for (let i = 0; i < tablerows.items.length; i++) {
        console.log(tablerows.items[i].index);
    }
});

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableRowCollection;

Parámetros

Devoluciones

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.TableRowCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TableRowCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Excel.Interfaces.TableRowCollectionData;

Devoluciones