Excel.TableColumnCollection class
Representa uma coleção de todas as colunas que fazem parte da tabela.
- Extends
Comentários
[Conjunto de apis: 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. |
| 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. |
| add |
Adiciona uma nova coluna à tabela. Ao contrário |
| get |
Obtém a quantidade de colunas na tabela. |
| get |
Obtém um objeto de coluna por nome ou ID. |
| get |
Obtém uma coluna com base em sua posição na coleção. |
| get |
Obtém um objeto de coluna por nome ou ID. Se a coluna não existir, esse método retornará um objeto com sua |
| 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 |
| 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
count
Retorna o número de colunas na tabela.
readonly count: number;Valor da propriedade
number
Comentários
[Conjunto de apis: 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, o nome padrão será usado.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.1 requer um índice menor que a 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 name no momento da criação.]
addAsJson(index, values, name)
Adiciona uma nova coluna à tabela. Ao contrário add()do , addAsJson() usa 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, o nome padrão será usado.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.16]
getCount()
Obtém a quantidade de colunas na tabela.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
[Conjunto de apis: 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 apis: ExcelApi 1.1]
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 apis: ExcelApi 1.1]
getItemOrNullObject(key)
Obtém um objeto de coluna por nome ou ID. Se a coluna não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getItemOrNullObject(key: number | string): Excel.TableColumn;Parâmetros
- key
-
number | string
Nome ou ID da coluna.
Retornos
Comentários
[Conjunto de apis: 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
Fornece opções para quais propriedades do objeto devem ser carregadas.
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 de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
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 de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.TableColumnCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TableColumnCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.TableColumnCollectionData;