Excel.TableRowCollection class
Representa uma coleção de todas as linhas que fazem parte da tabela.
Observe que, ao contrário de intervalos ou colunas, que serão ajustados se novas linhas ou colunas forem adicionadas antes delas, um TableRow objeto representa o local físico da linha de tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha de tabela continuará apontando para o índice para o qual ele foi criado.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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, always |
Adiciona uma ou mais linhas à tabela. O objeto de retorno será a parte superior das linhas adicionadas recentemente. Observe que, ao contrário de intervalos ou colunas, que serão ajustados se novas linhas ou colunas forem adicionadas antes delas, um |
| add |
Adiciona uma ou mais linhas à tabela. O objeto retornado será a linha superior da linha ou linhas recém-adicionadas. Ao contrário Observe que, ao contrário de intervalos ou colunas, que serão ajustados se novas linhas ou colunas forem adicionadas antes delas, um |
| delete |
Exclua várias linhas de uma tabela. Essas linhas não precisam ser sequenciais. Esse método gerará o |
| delete |
Exclua um número especificado de linhas de uma tabela, começando em um determinado índice. Esse método lançará o |
| get |
Obtém a quantidade de linhas na tabela. |
| get |
Obtém uma linha com base em sua posição na coleção. Observe que, ao contrário de intervalos ou colunas, que serão ajustados se novas linhas ou colunas forem adicionadas antes delas, um |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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
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.
Observe que, ao contrário de intervalos ou colunas, que serão ajustados se novas linhas ou colunas forem adicionadas antes delas, um TableRow objeto representa o local físico da linha de tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha de tabela continuará apontando para o índice para o qual ele foi criado.
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 de tabela.
- alwaysInsert
-
boolean
Opcional. Especifica se as novas linhas serão inseridas na tabela quando novas linhas forem adicionadas. Se true, as novas linhas serão inseridas na tabela. Se false, as novas linhas serão adicionadas abaixo da tabela. O padrão é true.
Retornos
Comentários
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 retornado será a linha superior da linha ou linhas recém-adicionadas. Ao contrário add()de , addAsJson() usa qualquer tipo de valor de célula, como tipos de dados de imagem ou entidade.
Observe que, ao contrário de intervalos ou colunas, que serão ajustados se novas linhas ou colunas forem adicionadas antes delas, um TableRow objeto representa o local físico da linha de tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha de tabela continuará apontando para o índice para o qual ele foi criado.
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 de tabela.
- alwaysInsert
-
boolean
Opcional. Especifica se as novas linhas serão inseridas na tabela quando novas linhas forem adicionadas. Se true, as novas linhas serão inseridas na tabela. Se false, as novas linhas serão adicionadas abaixo da tabela. O padrão é true.
Retornos
Comentários
deleteRows(rows)
Exclua várias linhas de uma tabela. Essas linhas não precisam ser sequenciais. Esse método gerará o InvalidArgument erro se uma linha escolhida já tiver sido excluída ou não existir. Esse método lançará 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 serem excluídos da tabela.
Retornos
void
Comentários
deleteRowsAt(index, count)
Exclua um número especificado de linhas de uma tabela, começando em um determinado índice. Esse método lançará 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 do índice da linha a ser excluída. Observação: os índices de linha são atualizados sempre que uma linha anterior na tabela é excluída após cada operação de exclusão. Verifique se o índice da linha que você deseja excluir não foi alterado entre a hora em que você determinou o valor e a hora em que você executa a operação.
- count
-
number
Número de linhas a serem excluídas. Por padrão, uma única linha será excluída.
Retornos
void
Comentários
getCount()
Obtém a quantidade de linhas na tabela.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItemAt(index)
Obtém uma linha com base em sua posição na coleção.
Observe que, ao contrário de intervalos ou colunas, que serão ajustados se novas linhas ou colunas forem adicionadas antes delas, um TableRow objeto representa o local físico da linha de tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha de tabela continuará apontando para o índice para o qual ele foi criado.
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
Fornece opções para quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original Excel.TableRowCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado 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
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de