Excel.TableColumnCollection class

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Retorna o número de colunas na tabela.

readonly count: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.TableColumn[];

Valor da propriedade

Adiciona uma nova coluna à tabela.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: o ExcelApi 1.1 requer um índice inferior à contagem total de colunas; 1,4 permite que o índice seja opcional (nulo ou -1) e acrescentará uma coluna no final; 1,4 permite o parâmetro de nome no momento da criação. ]

Exemplos

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

Adiciona uma nova coluna à tabela. Ao contrário add()de , addAsJson() utiliza qualquer tipo de valor de célula, como tipos de dados de imagem ou entidade.

addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.TableColumn;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Obtém a quantidade de colunas na tabela.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

Obtém um objeto de coluna por nome ou ID.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

Obtém uma coluna com base em sua posição na coleção.

getItemAt(index: number): Excel.TableColumn;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

Obtém um objeto de coluna por nome ou ID. Se a coluna não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Exemplos

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

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.TableColumnCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TableColumnCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.TableColumnCollectionData;

Retornos