Excel.TableColumn class
Representa uma coluna em uma tabela.
- Extends
Comentários
[ Conjunto de API: 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. |
| filter | Recupera 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 de tabela. |
| values | Representa os valores brutos do intervalo especificado. Os dados retornados podem ser uma cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor retornado começar com uma adição ("+"), menos ("-"), ou sinal igual ("="), o Excel interpretará esse valor como uma fórmula. |
| values |
Uma representação JSON dos valores nas células nesta coluna de tabela. Ao contrário |
| values |
Uma representação JSON dos valores nas células nesta coluna de tabela. Ao contrário |
Métodos
| delete() | Exclui a coluna da tabela. |
| get |
Obtém o objeto de intervalo associado ao corpo de dados da coluna. |
| get |
Obtém o objeto de intervalo associado à linha de cabeçalho da coluna. |
| get |
Obtém o objeto de intervalo associado a toda a coluna. |
| get |
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 |
| 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 |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| 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
filter
Recupera o filtro aplicado à coluna.
readonly filter: Excel.Filter;Valor da propriedade
Comentários
id
Retorna uma chave exclusiva que identifica a coluna na tabela.
readonly id: number;Valor da propriedade
number
Comentários
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
name
Especifica o nome da coluna de 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 retornados podem ser uma cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor retornado começar com uma adição ("+"), menos ("-"), ou sinal igual ("="), o Excel interpretará esse valor como uma fórmula.
values: any[][];Valor da propriedade
any[][]
Comentários
valuesAsJson
Uma representação JSON dos valores nas células nesta coluna de tabela. Ao contrário TableColumn.valuesde , TableColumn.valuesAsJson dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade en-US. Para recuperar dados na localidade de exibição do usuário, use TableColumn.valuesAsJsonLocal.
valuesAsJson: CellValue[][];Valor da propriedade
Excel.CellValue[][]
Comentários
valuesAsJsonLocal
Uma representação JSON dos valores nas células nesta coluna de tabela. Ao contrário TableColumn.valuesde , TableColumn.valuesAsJsonLocal dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham à localidade de exibição do usuário. Para recuperar dados independentes da localidade, use TableColumn.valuesAsJson.
valuesAsJsonLocal: CellValue[][];Valor da propriedade
Excel.CellValue[][]
Comentários
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
Fornece opções para quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.TableColumn original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TableColumnData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.TableColumnData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de