Excel.TableRowCollection class

Representa uma coleção de todas as linhas que fazem parte da tabela.

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.

Extends

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

context

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

count

Retorna o número de linhas na tabela.

items

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

Métodos

add(index, values, alwaysInsert)

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.

addAsJson(index, values, alwaysInsert)

Adiciona uma ou mais linhas à tabela. O objeto devolvido será a linha superior da linha ou linhas adicionadas recentemente. Ao contrário add()de , addAsJson() utiliza qualquer tipo de valor de célula, como tipos de dados de imagem ou entidade.

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.

deleteRows(rows)

Eliminar várias linhas de uma tabela. Estas linhas não precisam de ser sequenciais. Este método emitirá o InvalidArgument erro se uma linha escolhida já tiver sido eliminada ou não existir. Este método emitirá o InsertDeleteConflict erro se a tabela na qual o método é chamado tiver um filtro aplicado.

deleteRowsAt(index, count)

Elimine um número especificado de linhas de uma tabela, começando num determinado índice. Este método emitirá o InsertDeleteConflict erro se a tabela na qual o método é chamado tiver um filtro aplicado.

getCount()

Obtém a quantidade de linhas na tabela.

getItemAt(index)

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.

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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.

Detalhes da propriedade

context

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

count

Retorna o número de linhas na tabela.

readonly count: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

items

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

readonly items: Excel.TableRow[];

Valor da propriedade

Detalhes do método

add(index, values, alwaysInsert)

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

index

number

Opcional. Especifica a posição relativa da nova linha. Se for null ou -1, a adição ocorre no final. Todas as linhas abaixo da linha inserida serão deslocadas para baixo. Indexado com zero.

values

Array<Array<boolean | string | number>> | boolean | string | number

Opcional. Uma matriz 2D de valores não formatados da linha da tabela.

alwaysInsert

boolean

Opcional. Especifica se as novas linhas serão inseridas na tabela quando forem adicionadas novas linhas. Se true, as novas linhas serão inseridas na tabela. Se false, as novas linhas serão adicionadas abaixo da tabela. A predefinição é true.

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

addAsJson(index, values, alwaysInsert)

Adiciona uma ou mais linhas à tabela. O objeto devolvido será a linha superior da linha ou linhas adicionadas recentemente. Ao contrário add()de , addAsJson() utiliza qualquer tipo de valor de célula, como tipos de dados de imagem ou entidade.

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.

addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean): Excel.TableRow;

Parâmetros

index

number

Opcional. Especifica a posição relativa da nova linha. Se for null ou -1, a adição ocorre no final. Todas as linhas abaixo da linha inserida serão deslocadas para baixo. Indexado com zero.

values

Excel.CellValue[][]

Opcional. Uma matriz 2D de valores de célula da linha da tabela.

alwaysInsert

boolean

Opcional. Especifica se as novas linhas serão inseridas na tabela quando forem adicionadas novas linhas. Se true, as novas linhas serão inseridas na tabela. Se false, as novas linhas serão adicionadas abaixo da tabela. A predefinição é true.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

deleteRows(rows)

Eliminar várias linhas de uma tabela. Estas linhas não precisam de ser sequenciais. Este método emitirá o InvalidArgument erro se uma linha escolhida já tiver sido eliminada ou não existir. Este método emitirá o InsertDeleteConflict erro se a tabela na qual o método é chamado tiver um filtro aplicado.

deleteRows(rows: number[] | TableRow[]): void;

Parâmetros

rows

number[] | Excel.TableRow[]

Uma matriz de números de índice de linha ou objetos de linha a eliminar da tabela.

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

deleteRowsAt(index, count)

Elimine um número especificado de linhas de uma tabela, começando num determinado índice. Este método emitirá o InsertDeleteConflict erro se a tabela na qual o método é chamado tiver um filtro aplicado.

deleteRowsAt(index: number, count?: number): void;

Parâmetros

index

number

O valor de índice da linha a eliminar. Nota: os índices de linha são atualizados sempre que uma linha anterior na tabela é eliminada, após cada operação de eliminação. Certifique-se de que o índice da linha que pretende eliminar não foi alterado entre o momento em que determinou o valor e a hora em que executou a operação.

count

number

Número de linhas a eliminar. Por predefinição, será eliminada uma única linha.

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getCount()

Obtém a quantidade de linhas na tabela.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

getItemAt(index)

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

index

number

Valor de índice do objeto a ser recuperado. Indexados com zero.

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

load(options)

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

options

Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

load(propertyNames)

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

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

toJSON()

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