Excel.TableColumnCollection interface

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

Propriedades

count

Retorna o número de colunas na tabela.

Métodos

add(index, values, name)

Adiciona uma nova coluna à tabela.

getCount()

Obtém a quantidade de colunas na tabela.

getItem(key)

Obtém um objeto de coluna por nome ou ID.

getItemAt(index)

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

getItemOrNullObject(key)

Obtém um objeto column por nome ou ID. Se a coluna 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 colunas na tabela.

readonly count: number;

Valor da propriedade

number

Detalhes do método

add(index, values, name)

Adiciona uma nova coluna à tabela.

add(
            index?: number,
            values?:
                | Array<Array<boolean | string | number>>
                | boolean
                | string
                | number,
            name?: string
        ): TableColumn;

Parâmetros

index
number

Opcional. Especifica a posição relativa da nova coluna. Se for null ou -1, a adição ocorre no final. Colunas com um índice superior serão deslocadas para o lado. Indexado com zero.

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

Opcional. Uma matriz bidimensional de valores não formatados da coluna da tabela.

name
string

Opcional. Especifica o nome da nova coluna. Se for null, o nome padrão será usado.

Retornos

getCount()

Obtém a quantidade de colunas na tabela.

getCount(): ClientResult<number>;

Retornos

ClientResult<number>

getItem(key)

Obtém um objeto de coluna por nome ou ID.

getItem(key: number | string): TableColumn;

Parâmetros

key
number | string

ID ou nome da coluna.

Retornos

getItemAt(index)

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

getItemAt(index: number): TableColumn;

Parâmetros

index
number

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

Retornos

getItemOrNullObject(key)

Obtém um objeto column por nome ou ID. Se a coluna não existir, retornará um objeto null.

getItemOrNullObject(key: number | string): TableColumn;

Parâmetros

key
number | string

ID ou nome da coluna.

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