Excel.TableCollection interface

Representa uma coleção de todas as tabelas que fazem parte da pasta de trabalho ou planilha, dependendo de como ela foi atingida.

Propriedades

count

Retorna o número de tabelas na pasta de trabalho.

Métodos

add(address, hasHeaders)

Cria uma nova tabela. O objeto de intervalo ou endereço de origem determina a planilha à qual a tabela será adicionada. Se a tabela não puder ser adicionada (por exemplo, porque o endereço é inválido ou a tabela se sobreporia a outra), será gerado um erro.

getCount()

Obtém o número de tabelas na coleção.

getItem(key)

Obtém uma tabela pelo nome ou ID.

getItemAt(index)

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

getItemOrNullObject(key)

Obtém uma tabela pelo nome ou ID. Se a tabela não existir, retornará um objeto null.

load(propertyNames)

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

Detalhes da propriedade

count

Retorna o número de tabelas na pasta de trabalho.

readonly count: number;

Valor da propriedade

number

Detalhes do método

add(address, hasHeaders)

Cria uma nova tabela. O objeto de intervalo ou endereço de origem determina a planilha à qual a tabela será adicionada. Se a tabela não puder ser adicionada (por exemplo, porque o endereço é inválido ou a tabela se sobreporia a outra), será gerado um erro.

add(address: Range | string, hasHeaders: boolean): Table;

Parâmetros

address
Range | string

Um objeto Range, um endereço de cadeia de caracteres ou o nome do objeto de intervalo que representa a fonte de dados. Se o endereço não contiver o nome de uma planilha, a folha ativa no momento será usada.

hasHeaders
boolean

Valor booliano que indica se os dados que estão sendo importados têm rótulos de coluna. Se a origem não contiver cabeçalhos (ou seja, quando essa propriedade estiver definida como falso), o Excel gerará automaticamente um cabeçalho, deslocando os dados uma linha para baixo.

Retornos

getCount()

Obtém o número de tabelas na coleção.

getCount(): ClientResult<number>;

Retornos

ClientResult<number>

getItem(key)

Obtém uma tabela pelo nome ou ID.

getItem(key: string): Table;

Parâmetros

key
string

Nome ou ID da tabela a ser recuperada.

Retornos

getItemAt(index)

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

getItemAt(index: number): Table;

Parâmetros

index
number

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

Retornos

getItemOrNullObject(key)

Obtém uma tabela pelo nome ou ID. Se a tabela não existir, retornará um objeto null.

getItemOrNullObject(key: string): Table;

Parâmetros

key
string

Nome ou ID da tabela a ser recuperada.

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[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void