Excel.TableRowCollection class
Representa una colección de todas las filas que forman parte de la tabla.
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ó.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| count | Devuelve el número de filas de la tabla. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(index, values, always |
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 |
| add |
Agrega una o más filas a la tabla. El objeto devuelto será la fila superior de la fila o filas recién agregadas. A diferencia 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 |
| delete |
Elimine varias filas de una tabla. No es necesario que estas filas sean secuenciales. Este método producirá el |
| delete |
Elimine un número especificado de filas de una tabla, empezando por un índice determinado. Este método producirá el |
| get |
Obtiene el número de filas de la tabla. |
| get |
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 |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
context
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
count
Devuelve el número de filas de la tabla.
readonly count: number;Valor de propiedad
number
Comentarios
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.TableRow[];Valor de propiedad
Detalles del método
add(index, values, alwaysInsert)
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
- index
-
number
Opcional. Especifica la posición relativa de la nueva fila. Si es NULL o -1, se produce la adición al final. Las filas situadas debajo de la fila insertada se desplazan hacia abajo. Indizado con cero.
- values
-
Array<Array<boolean | string | number>> | boolean | string | number
Opcional. Matriz 2D de valores sin formato de la fila de tabla.
- alwaysInsert
-
boolean
Opcional. Especifica si las nuevas filas se insertarán en la tabla cuando se agreguen nuevas filas. Si truees , las nuevas filas se insertarán en la tabla. Si falsees , las nuevas filas se agregarán debajo de la tabla. El valor predeterminado es true.
Devoluciones
Comentarios
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);
});
addAsJson(index, values, alwaysInsert)
Agrega una o más filas a la tabla. El objeto devuelto será la fila superior de la fila o filas recién agregadas. A diferencia add()de , addAsJson() toma cualquier tipo de valor de celda, como tipos de datos de imagen o entidad.
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ó.
addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean): Excel.TableRow;Parámetros
- index
-
number
Opcional. Especifica la posición relativa de la nueva fila. Si es NULL o -1, se produce la adición al final. Las filas situadas debajo de la fila insertada se desplazan hacia abajo. Indizado con cero.
- values
-
Excel.CellValue[][]
Opcional. Matriz 2D de valores de celda de la fila de tabla.
- alwaysInsert
-
boolean
Opcional. Especifica si las nuevas filas se insertarán en la tabla cuando se agreguen nuevas filas. Si truees , las nuevas filas se insertarán en la tabla. Si falsees , las nuevas filas se agregarán debajo de la tabla. El valor predeterminado es true.
Devoluciones
Comentarios
deleteRows(rows)
Elimine varias filas de una tabla. No es necesario que estas filas sean secuenciales. Este método producirá el InvalidArgument error si ya se ha eliminado una fila elegida o no existe. Este método producirá el InsertDeleteConflict error si la tabla en la que se llama al método tiene aplicado un filtro.
deleteRows(rows: number[] | TableRow[]): void;Parámetros
- rows
-
number[] | Excel.TableRow[]
Matriz de números de índice de fila u objetos de fila que se van a eliminar de la tabla.
Devoluciones
void
Comentarios
deleteRowsAt(index, count)
Elimine un número especificado de filas de una tabla, empezando por un índice determinado. Este método producirá el InsertDeleteConflict error si la tabla en la que se llama al método tiene aplicado un filtro.
deleteRowsAt(index: number, count?: number): void;Parámetros
- index
-
number
Valor de índice de la fila que se va a eliminar. Nota: Los índices de fila se actualizan cada vez que se elimina una fila anterior de la tabla, después de cada operación de eliminación. Asegúrese de que el índice de la fila que desea eliminar no ha cambiado entre el momento en que determinó el valor y el momento en que se ejecuta la operación.
- count
-
number
Número de filas que se van a eliminar. De forma predeterminada, se eliminará una sola fila.
Devoluciones
void
Comentarios
getCount()
Obtiene el número de filas de la tabla.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getItemAt(index)
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
- index
-
number
Valor de índice del objeto que se va a recuperar. Indizado con cero.
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);
});
load(options)
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
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
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
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
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);
}
});
load(propertyNamesAndPaths)
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
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
toJSON()
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;