Compartilhar via


Excel.TableColumnCollection class

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

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 colunas na tabela.

items

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

Métodos

add(index, values, name)

Adiciona uma nova coluna à tabela.

addAsJson(index, values, name)

Adiciona uma nova coluna à tabela. Ao contrário add()de , addAsJson() utiliza qualquer tipo de valor de célula, como tipos de dados de imagem ou entidade.

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 de coluna por nome ou ID. Se a coluna não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

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.TableColumnCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TableColumnCollectionData) 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 colunas 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.TableColumn[];

Valor da propriedade

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): Excel.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 2D de valores não formatados da coluna da tabela.

name

string

Opcional. Especifica o nome da nova coluna. Se null, será utilizado o nome predefinido.

Retornos

Comentários

[ Conjunto de API: o ExcelApi 1.1 requer um índice inferior à contagem total de colunas; 1,4 permite que o índice seja opcional (nulo ou -1) e acrescentará uma coluna no final; 1,4 permite o parâmetro de nome no momento da criação. ]

Exemplos

await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    const values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]];
    const column = tables.getItem("Table1").columns.add(null, values);
    column.load('name');
    await context.sync();
    
    console.log(column.name);
});

addAsJson(index, values, name)

Adiciona uma nova coluna à tabela. Ao contrário add()de , addAsJson() utiliza qualquer tipo de valor de célula, como tipos de dados de imagem ou entidade.

addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.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

Excel.CellValue[][]

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

name

string

Opcional. Especifica o nome da nova coluna. Se null, será utilizado o nome predefinido.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

getCount()

Obtém a quantidade de colunas na tabela.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

getItem(key)

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

getItem(key: number | string): Excel.TableColumn;

Parâmetros

key

number | string

Nome ou ID da coluna.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

await Excel.run(async (context) => { 
    const tableColumn = context.workbook.tables.getItem('Table1').columns.getItem(0);
    tableColumn.load('name');
    await context.sync();
    console.log(tableColumn.name);
});

getItemAt(index)

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

getItemAt(index: number): Excel.TableColumn;

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 tableColumn = context.workbook.tables.getItem['Table1'].columns.getItemAt(0);
    tableColumn.load('name');
    await context.sync();
    console.log(tableColumn.name);
});

getItemOrNullObject(key)

Obtém um objeto de coluna por nome ou ID. Se a coluna não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getItemOrNullObject(key: number | string): Excel.TableColumn;

Parâmetros

key

number | string

Nome ou ID da coluna.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

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.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection;

Parâmetros

options

Excel.Interfaces.TableColumnCollectionLoadOptions & 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.TableColumnCollection;

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 tableColumns = context.workbook.tables.getItem('Table1').columns;
    tableColumns.load('items');
    await context.sync();
    
    console.log("tableColumns Count: " + tableColumns.count);
    for (let i = 0; i < tableColumns.items.length; i++) {
        console.log(tableColumns.items[i].name);
    }
});

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.TableColumnCollection;

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.TableColumnCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TableColumnCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.TableColumnCollectionData;

Retornos