Excel.TableColumnCollection class
Representa una colección de todas las columnas que forman parte de la tabla.
- 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 columnas de la tabla. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(index, values, name) | Agrega una nueva columna a la tabla. |
| add |
Agrega una nueva columna a la tabla. A diferencia |
| get |
Obtiene el número de columnas de la tabla. |
| get |
Obtiene un objeto de columna por nombre o identificador. |
| get |
Obtiene una columna en función de su posición en la colección. |
| get |
Obtiene un objeto de columna por nombre o identificador. Si la columna no existe, este método devuelve un objeto con su |
| 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 columnas de la tabla.
readonly count: number;Valor de propiedad
number
Comentarios
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.TableColumn[];Valor de propiedad
Detalles del método
add(index, values, name)
Agrega una nueva columna a la tabla.
add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string): Excel.TableColumn;Parámetros
- index
-
number
Opcional. Especifica la posición relativa de la nueva columna. Si es NULL o -1, se produce la adición al final. Las columnas con un índice más alto se desplazarán a un lado. Indizado con cero.
- values
-
Array<Array<boolean | string | number>> | boolean | string | number
Opcional. Matriz 2D de valores sin formato de la columna de tabla.
- name
-
string
Opcional. Especifica el nombre de la nueva columna. Si nulles , se usará el nombre predeterminado.
Devoluciones
Comentarios
Ejemplos
await Excel.run(async (context) => {
const tables = context.workbook.tables;
const values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]];
const column = tables.getItem("Table1").columns.add(null, values);
column.load('name');
await context.sync();
console.log(column.name);
});
addAsJson(index, values, name)
Agrega una nueva columna a la tabla. A diferencia add()de , addAsJson() toma cualquier tipo de valor de celda, como tipos de datos de imagen o entidad.
addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.TableColumn;Parámetros
- index
-
number
Opcional. Especifica la posición relativa de la nueva columna. Si es NULL o -1, se produce la adición al final. Las columnas con un índice más alto se desplazarán a un lado. Indizado con cero.
- values
-
Excel.CellValue[][]
Opcional. Matriz 2D de valores de celda de la columna de tabla.
- name
-
string
Opcional. Especifica el nombre de la nueva columna. Si nulles , se usará el nombre predeterminado.
Devoluciones
Comentarios
getCount()
Obtiene el número de columnas de la tabla.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getItem(key)
Obtiene un objeto de columna por nombre o identificador.
getItem(key: number | string): Excel.TableColumn;Parámetros
- key
-
number | string
Nombre o identificador de columna.
Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Ejemplos
await Excel.run(async (context) => {
const tableColumn = context.workbook.tables.getItem('Table1').columns.getItem(0);
tableColumn.load('name');
await context.sync();
console.log(tableColumn.name);
});
getItemAt(index)
Obtiene una columna en función de su posición en la colección.
getItemAt(index: number): Excel.TableColumn;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 tableColumn = context.workbook.tables.getItem['Table1'].columns.getItemAt(0);
tableColumn.load('name');
await context.sync();
console.log(tableColumn.name);
});
getItemOrNullObject(key)
Obtiene un objeto de columna por nombre o identificador. Si la columna no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getItemOrNullObject(key: number | string): Excel.TableColumn;Parámetros
- key
-
number | string
Nombre o identificador de columna.
Devoluciones
Comentarios
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.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection;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.TableColumnCollection;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 tableColumns = context.workbook.tables.getItem('Table1').columns;
tableColumns.load('items');
await context.sync();
console.log("tableColumns Count: " + tableColumns.count);
for (let i = 0; i < tableColumns.items.length; i++) {
console.log(tableColumns.items[i].name);
}
});
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.TableColumnCollection;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.TableColumnCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TableColumnCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): Excel.Interfaces.TableColumnCollectionData;