Excel.TableRowCollection 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 linhas 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.TableRow[];

Valor da propriedade

Adiciona uma ou mais linhas à tabela. O objeto de retorno será a parte superior das linhas adicionadas recentemente.

Tenha em atenção que, ao contrário dos intervalos ou colunas, que serão ajustados se forem adicionadas novas linhas ou colunas antes delas, um TableRow objeto representa a localização física da linha da tabela, mas não os dados. Ou seja, se os dados estiverem ordenados ou se forem adicionadas novas linhas, uma linha de tabela continuará a apontar para o índice para o qual foram criados.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 para adicionar uma única linha; 1,4 permite a adição de várias linhas; 1,15 para adicionar alwaysInsert parâmetro. ]

Exemplos

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

Obtém a quantidade de linhas na tabela.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

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

Tenha em atenção que, ao contrário dos intervalos ou colunas, que serão ajustados se forem adicionadas novas linhas ou colunas antes delas, um TableRow objeto representa a localização física da linha da tabela, mas não os dados. Ou seja, se os dados estiverem ordenados ou se forem adicionadas novas linhas, uma linha de tabela continuará a apontar para o índice para o qual foram criados.

getItemAt(index: number): Excel.TableRow;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

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.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection;

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

Parâmetros

Retornos

Exemplos

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

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

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.TableRowCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TableRowCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.TableRowCollectionData;

Retornos