Compartilhar via


Excel.TableColumn class

Representa uma coluna em uma 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.

filter

Obtém o filtro aplicado à coluna.

id

Retorna uma chave exclusiva que identifica a coluna na tabela.

index

Retorna o número de índice da coluna na coleção de colunas da tabela. Indexado com zero.

name

Especifica o nome da coluna da tabela.

values

Representa os valores brutos do intervalo especificado. Os dados devolvidos podem ser uma cadeia, número ou booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor devolvido começar com uma adição ("+"), sinal de subtração ("-"), ou sinal de igual ("="), o Excel interpreta este valor como uma fórmula.

valuesAsJson

Uma representação JSON dos valores nas células nesta coluna de tabela. Ao contrário TableColumn.valuesde , TableColumn.valuesAsJson suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região en-US. Para obter dados na região de apresentação do utilizador, utilize TableColumn.valuesAsJsonLocal.

valuesAsJsonLocal

Uma representação JSON dos valores nas células nesta coluna de tabela. Ao contrário TableColumn.valuesde , TableColumn.valuesAsJsonLocal suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região de apresentação do utilizador. Para obter dados independentemente da região, utilize TableColumn.valuesAsJson.

Métodos

delete()

Exclui a coluna da tabela.

getDataBodyRange()

Obtém o objeto de intervalo associado ao corpo de dados da coluna.

getHeaderRowRange()

Obtém o objeto de intervalo associado à linha de cabeçalho da coluna.

getRange()

Obtém o objeto de intervalo associado a toda a coluna.

getTotalRowRange()

Obtém o objeto de intervalo associado à linha de totais da coluna.

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.

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

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 Excel.TableColumn original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TableColumnData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

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

filter

Obtém o filtro aplicado à coluna.

readonly filter: Excel.Filter;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

id

Retorna uma chave exclusiva que identifica a coluna na tabela.

readonly id: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

index

Retorna o número de índice da coluna na coleção de colunas da tabela. Indexado com zero.

readonly index: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

name

Especifica o nome da coluna da tabela.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 para obter o nome; 1.4 para defini-lo. ]

values

Representa os valores brutos do intervalo especificado. Os dados devolvidos podem ser uma cadeia, número ou booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor devolvido começar com uma adição ("+"), sinal de subtração ("-"), ou sinal de igual ("="), o Excel interpreta este valor como uma fórmula.

values: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

valuesAsJson

Uma representação JSON dos valores nas células nesta coluna de tabela. Ao contrário TableColumn.valuesde , TableColumn.valuesAsJson suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região en-US. Para obter dados na região de apresentação do utilizador, utilize TableColumn.valuesAsJsonLocal.

valuesAsJson: CellValue[][];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

valuesAsJsonLocal

Uma representação JSON dos valores nas células nesta coluna de tabela. Ao contrário TableColumn.valuesde , TableColumn.valuesAsJsonLocal suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região de apresentação do utilizador. Para obter dados independentemente da região, utilize TableColumn.valuesAsJson.

valuesAsJsonLocal: CellValue[][];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Detalhes do método

delete()

Exclui a coluna da tabela.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItemAt(2);
    column.delete();
    await context.sync(); 
});

getDataBodyRange()

Obtém o objeto de intervalo associado ao corpo de dados da coluna.

getDataBodyRange(): Excel.Range;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const dataBodyRange = column.getDataBodyRange();
    dataBodyRange.load('address');
    await context.sync();
    
    console.log(dataBodyRange.address);
});

getHeaderRowRange()

Obtém o objeto de intervalo associado à linha de cabeçalho da coluna.

getHeaderRowRange(): Excel.Range;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const headerRowRange = columns.getHeaderRowRange();
    headerRowRange.load('address');
    await context.sync();
    
    console.log(headerRowRange.address);
});

getRange()

Obtém o objeto de intervalo associado a toda a coluna.

getRange(): Excel.Range;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const columnRange = columns.getRange();
    columnRange.load('address');
    await context.sync();
    
    console.log(columnRange.address);
});

getTotalRowRange()

Obtém o objeto de intervalo associado à linha de totais da coluna.

getTotalRowRange(): Excel.Range;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const totalRowRange = columns.getTotalRowRange();
    totalRowRange.load('address');
    await context.sync();
    
    console.log(totalRowRange.address);
});

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.TableColumnLoadOptions): Excel.TableColumn;

Parâmetros

options
Excel.Interfaces.TableColumnLoadOptions

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

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 tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItem(0);
    column.load('index');
    await context.sync();
    
    console.log(column.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?: {
            select?: string;
            expand?: string;
        }): Excel.TableColumn;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.TableColumnUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.TableColumn): void;

Parâmetros

properties
Excel.TableColumn

Retornos

void

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 Excel.TableColumn original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TableColumnData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.TableColumnData;

Retornos