Excel.TableColumn 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 una clave única que identifica la columna de la tabla.

readonly id: number;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Devuelve el número de índice de la columna dentro de la colección de columnas de la tabla. Indizado con cero.

readonly index: number;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Especifica el nombre de la columna de tabla.

name: string;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 para obtener el nombre; 1.4 para establecerlo. ]

Representa los valores sin formato del rango especificado. Los datos devueltos podrían ser una cadena, un número o un valor booleano. Las celdas que contienen un error devolverán la cadena de error. Si el valor devuelto comienza con un signo más ("+"), menos ("-") o un signo igual ("="), Excel interpreta este valor como una fórmula.

values: any[][];

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Elimina la columna de la tabla.

delete(): void;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItemAt(2);
    column.delete();
    await context.sync(); 
});

Obtiene el objeto de rango asociado al cuerpo de datos de la columna.

getDataBodyRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const dataBodyRange = column.getDataBodyRange();
    dataBodyRange.load('address');
    await context.sync();
    
    console.log(dataBodyRange.address);
});

Obtiene el objeto de rango asociado a la fila de encabezado de la columna.

getHeaderRowRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const headerRowRange = columns.getHeaderRowRange();
    headerRowRange.load('address');
    await context.sync();
    
    console.log(headerRowRange.address);
});

Obtiene el objeto de rango asociado a toda la columna.

getRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const columnRange = columns.getRange();
    columnRange.load('address');
    await context.sync();
    
    console.log(columnRange.address);
});

Obtiene el objeto de rango asociado a la fila de totales de la columna.

getTotalRowRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const totalRowRange = columns.getTotalRowRange();
    totalRowRange.load('address');
    await context.sync();
    
    console.log(totalRowRange.address);
});

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.TableColumnLoadOptions): Excel.TableColumn;

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

Parámetros

Devoluciones

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItem(0);
    column.load('index');
    await context.sync();
    
    console.log(column.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?: {
            select?: string;
            expand?: string;
        }): Excel.TableColumn;

Parámetros

Devoluciones

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.TableColumn): void;

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.TableColumn es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TableColumnData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.TableColumnData;

Devoluciones