Excel.TableCollection class
Representa uma coleção de todas as tabelas que fazem parte da pasta de trabalho ou planilha, dependendo de como ela foi atingida.
- 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 tabelas na pasta de trabalho. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(address, has |
Cria uma nova tabela. O objeto de intervalo ou endereço de origem determina a planilha à qual a tabela será adicionada. Se a tabela não puder ser adicionada (por exemplo, porque o endereço é inválido ou a tabela se sobreporia a outra), será gerado um erro. |
| get |
Obtém o número de tabelas na coleção. |
| get |
Obtém uma tabela pelo nome ou ID. |
| get |
Obtém uma tabela com base em sua posição na coleção. |
| get |
Obtém uma tabela pelo nome ou ID. Se a tabela não existir, este método devolve um objeto com a respetiva |
| 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 |
Eventos
| on |
Ocorre quando uma nova tabela é adicionada a um livro. |
| on |
Ocorre quando os dados são alterados em qualquer tabela num livro ou numa folha de cálculo. |
| on |
Ocorre quando a tabela especificada é excluída em uma pasta de trabalho. |
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 tabelas na pasta de trabalho.
readonly count: number;Valor da propriedade
number
Comentários
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.Table[];Valor da propriedade
Detalhes do método
add(address, hasHeaders)
Cria uma nova tabela. O objeto de intervalo ou endereço de origem determina a planilha à qual a tabela será adicionada. Se a tabela não puder ser adicionada (por exemplo, porque o endereço é inválido ou a tabela se sobreporia a outra), será gerado um erro.
add(address: Range | string, hasHeaders: boolean): Excel.Table;Parâmetros
- address
-
Excel.Range | string
Um Range objeto ou um endereço de cadeia ou nome do intervalo que representa a origem de dados. Se o endereço não contiver o nome de uma planilha, a folha ativa no momento será usada. [Conjunto de API: ExcelApi 1.1/ 1.3. Antes do ExcelApi 1.3, este parâmetro tem de ser uma cadeia. A partir da API 1.3 do Excel, este parâmetro pode ser um objeto de Intervalo ou uma cadeia.]
- hasHeaders
-
boolean
Um valor booleano que indica se os dados que estão a ser importados têm etiquetas de coluna. Se a origem não contiver cabeçalhos (ou seja, quando esta propriedade estiver definida como false), o Excel irá gerar automaticamente um cabeçalho e deslocar os dados para baixo uma linha.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
await Excel.run(async (context) => {
const table = context.workbook.tables.add('Sheet1!A1:E7', true);
table.load('name');
await context.sync();
console.log(table.name);
});
getCount()
Obtém o número de tabelas na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(key)
Obtém uma tabela pelo nome ou ID.
getItem(key: string): Excel.Table;Parâmetros
- key
-
string
Nome ou ID da tabela a ser recuperada.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.load('name');
await context.sync();
console.log(table.name);
});
getItemAt(index)
Obtém uma tabela com base em sua posição na coleção.
getItemAt(index: number): Excel.Table;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 table = context.workbook.tables.getItemAt(0);
table.load('name');
await context.sync();
console.log(table.name);
});
getItemOrNullObject(key)
Obtém uma tabela pelo nome ou ID. Se a tabela 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: string): Excel.Table;Parâmetros
- key
-
string
Nome ou ID da tabela a ser recuperada.
Retornos
Comentários
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.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection;Parâmetros
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.TableCollection;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
Exemplos
// Get the number of tables.
await Excel.run(async (context) => {
const tables = context.workbook.tables;
tables.load('count');
await context.sync();
console.log(tables.count);
});
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.TableCollection;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.TableCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TableCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.TableCollectionData;Retornos
Detalhes do evento
onAdded
Ocorre quando uma nova tabela é adicionada a um livro.
readonly onAdded: OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>;Tipo de evento
Comentários
onChanged
Ocorre quando os dados são alterados em qualquer tabela num livro ou numa folha de cálculo.
readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;Tipo de evento
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml
await Excel.run(async (context) => {
let tables = context.workbook.tables;
tables.onChanged.add(onChange);
await context.sync();
console.log("A handler has been registered for the table collection onChanged event");
});
onDeleted
Ocorre quando a tabela especificada é excluída em uma pasta de trabalho.
readonly onDeleted: OfficeExtension.EventHandlers<Excel.TableDeletedEventArgs>;