Excel.TableScopedCollection class

  • Referência
Pacote:
excel

Representa uma coleção de tabelas no âmbito. Para cada tabela, o canto superior esquerdo é considerado a localização de âncora e as tabelas são ordenadas de cima para baixo e, em seguida, da esquerda para a direita.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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.
items

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

Métodos

getCount()

Obtém o número de tabelas na coleção.
getFirst()

Obtém a primeira tabela na coleção. As tabelas na coleção estão ordenadas de cima para baixo e da esquerda para a direita, de modo a que a tabela superior esquerda seja a primeira tabela na coleção.
getItem(key)

Obtém uma tabela pelo nome ou ID.
getItemOrNullObject(key)

Obtém uma tabela pelo nome ou ID. Se o objeto de 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).
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.TableScopedCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TableScopedCollectionData) 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

Excel.RequestContext

items

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

readonly items: Excel.Table[];

Valor da propriedade

Excel.Table[]

Detalhes do método

getCount()

Obtém o número de tabelas na coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getFirst()

Obtém a primeira tabela na coleção. As tabelas na coleção estão ordenadas de cima para baixo e da esquerda para a direita, de modo a que a tabela superior esquerda seja a primeira tabela na coleção.

getFirst(): Excel.Table;

Retornos

Excel.Table

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Excel.Table

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getItemOrNullObject(key)

Obtém uma tabela pelo nome ou ID. Se o objeto de 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

Excel.Table

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

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

Parâmetros

options

Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.TableScopedCollection

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.TableScopedCollection

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

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

Excel.TableScopedCollection

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

toJSON(): Excel.Interfaces.TableScopedCollectionData;

Retornos

Excel.Interfaces.TableScopedCollectionData