Excel.TableColumnCollection 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 columnas 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.TableColumn[];

Valor de propiedad

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

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 requiere un índice menor que el número total de columnas; 1.4 permite que el índice sea opcional (null o -1) y anexará una columna al final; 1.4 permite el parámetro name en el momento de la creación. ]

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

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

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

Obtiene el número de columnas de la tabla.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Obtiene un objeto de columna por nombre o identificador.

getItem(key: number | string): Excel.TableColumn;

Parámetros

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

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

getItemAt(index: number): Excel.TableColumn;

Parámetros

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

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

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

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

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.TableColumnCollection;

Parámetros

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

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

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

Devoluciones