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 se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um TableRow objeto representa o local físico da linha da tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha da tabela continuará apontando para o índice para o qual foi criada.
- Extends
Comentários
[Conjunto de apis: 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 se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um |
| add |
Adiciona uma ou mais linhas à tabela. O objeto retornado será a linha superior da(s) linha(s) recém-adicionada(s). Ao contrário Observe que, ao contrário de intervalos ou colunas, que se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um |
| 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 se ajustarão se novas linhas ou colunas forem adicionadas antes deles, 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
[Conjunto de apis: 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.
Observe que, ao contrário de intervalos ou colunas, que se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um TableRow objeto representa o local físico da linha da tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha da tabela continuará apontando para o índice para o qual foi criada.
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 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
[Conjunto de apis: ExcelApi 1.1 para adicionar uma única linha; 1.4 permite a adição de várias linhas; 1.15 para adicionar alwaysInsert parâmetros.]
addAsJson(index, values, alwaysInsert)
Adiciona uma ou mais linhas à tabela. O objeto retornado será a linha superior da(s) linha(s) recém-adicionada(s). Ao contrário add()do , 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 se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um TableRow objeto representa o local físico da linha da tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha da tabela continuará apontando para o índice para o qual foi criada.
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 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
[Conjunto de apis: ExcelApi 1.16]
getCount()
Obtém a quantidade de linhas na tabela.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
[Conjunto de apis: ExcelApi 1.4]
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 se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um TableRow objeto representa o local físico da linha da tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha da tabela continuará apontando para o índice para o qual foi criada.
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 apis: ExcelApi 1.1]
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 devem ser carregadas.
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írgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
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írgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula 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.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto 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 "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.TableRowCollectionData;