Excel.LinkedEntityDataDomainCollection class

Pacote:

excel

Representa uma coleção de LinkedEntityDataDomain objetos. A coleção pode conter domínios de dados de entidades ligadas, como ações, geografia ou moedas definidas por fornecedores de dados de serviços, como o Bing ou o Power BI, ou domínios de dados de entidades ligadas definidos pelos Suplementos do Office.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

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

add(options)	Adiciona um objeto de domínio de dados de entidade ligada definido pelo Suplemento do Office à coleção. Assim que o domínio de dados da entidade ligada for adicionado, pode ser utilizado para criar LinkedEntityCellValue objetos.
getCount()	Obtém o número de domínios de dados de entidade ligados na coleção.
getItem(id)	Obtém um domínio de dados de entidade ligada pelo respetivo id.
getItemAt(index)	Obtém um domínio de dados de entidade ligada pelo respetivo índice na coleção.
getItemByName(name)	Obtém um domínio de dados de entidade ligada pelo respetivo name.
getItemByNameOrNullObject(name)	Obtém um domínio de dados de entidade ligada pelo respetivo name. Se o domínio de dados da entidade ligada não existir, esta função devolverá 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(id)	Obtém um domínio de dados de entidade ligada pelo respetivo id. Se o domínio de dados da entidade ligada não existir, esta função devolverá 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.
refreshAll()	Atualiza todos os LinkedEntityCellValue objetos de todos os domínios de dados de entidades ligadas nesta coleção. O pedido de atualização pode falhar se os fornecedores de dados estiverem ocupados ou temporariamente inacessíveis.
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.LinkedEntityDataDomainCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.LinkedEntityDataDomainCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

Eventos

onLinkedEntityDataDomainAdded	Ocorre quando um novo domínio de dados de entidade ligada é adicionado ao livro.
onRefreshCompleted	Ocorre quando o pedido de atualização LinkedEntityCellValue de objetos de um domínio de dados de entidade ligada é concluído.
onRefreshModeChanged	Ocorre quando o refreshMode de um domínio de dados de entidade ligada é alterado.

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.LinkedEntityDataDomain[];

Valor da propriedade

Excel.LinkedEntityDataDomain[]

Detalhes do método

add(options)

Adiciona um objeto de domínio de dados de entidade ligada definido pelo Suplemento do Office à coleção. Assim que o domínio de dados da entidade ligada for adicionado, pode ser utilizado para criar LinkedEntityCellValue objetos.

add(options: Excel.LinkedEntityDataDomainCreateOptions): void;

Parâmetros

options

Excel.LinkedEntityDataDomainCreateOptions

Opções que são utilizadas para criar o domínio de dados de entidade ligada a adicionar.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

getCount()

Obtém o número de domínios de dados de entidade ligados na coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

getItem(id)

Obtém um domínio de dados de entidade ligada pelo respetivo id.

getItem(id: string): Excel.LinkedEntityDataDomain;

Parâmetros

id

string

O id do LinkedEntityDataDomain objeto a ser obtido.

Retornos

Excel.LinkedEntityDataDomain

O domínio de dados da entidade ligada com o especificado id. Se existirem vários domínios de dados de entidades ligadas com o mesmo id, será devolvido o que este Suplemento do Office definiu.

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

getItemAt(index)

Obtém um domínio de dados de entidade ligada pelo respetivo índice na coleção.

getItemAt(index: number): Excel.LinkedEntityDataDomain;

Parâmetros

index

number

O índice do domínio de dados da entidade ligada na coleção.

Retornos

Excel.LinkedEntityDataDomain

O domínio de dados da entidade ligada no índice especificado.

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

getItemByName(name)

Obtém um domínio de dados de entidade ligada pelo respetivo name.

getItemByName(name: string): Excel.LinkedEntityDataDomain;

Parâmetros

name

string

O name do LinkedEntityDataDomain objeto a ser obtido.

Retornos

Excel.LinkedEntityDataDomain

O domínio de dados da entidade ligada com o especificado name. Se existirem vários domínios de dados de entidades ligadas com o mesmo name, será devolvido o que este Suplemento do Office definiu.

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

getItemByNameOrNullObject(name)

Obtém um domínio de dados de entidade ligada pelo respetivo name. Se o domínio de dados da entidade ligada não existir, esta função devolverá 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).

getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;

Parâmetros

name

string

O name do LinkedEntityDataDomain objeto a ser obtido.

Retornos

Excel.LinkedEntityDataDomain

O domínio de dados da entidade ligada com o especificado name. Se existirem vários domínios de dados de entidades ligadas com o mesmo name, será devolvido o que este Suplemento do Office definiu.

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

getItemOrNullObject(id)

Obtém um domínio de dados de entidade ligada pelo respetivo id. Se o domínio de dados da entidade ligada não existir, esta função devolverá 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(id: string): Excel.LinkedEntityDataDomain;

Parâmetros

id

string

O id do LinkedEntityDataDomain objeto a ser obtido.

Retornos

Excel.LinkedEntityDataDomain

O domínio de dados da entidade ligada com o especificado id. Se existirem vários domínios de dados de entidades ligadas com o mesmo id, será devolvido o que este Suplemento do Office definiu.

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

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

Parâmetros

options

Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retornos

Excel.LinkedEntityDataDomainCollection

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

Parâmetros

propertyNames

string | string[]

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

Retornos

Excel.LinkedEntityDataDomainCollection

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

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

refreshAll()

Atualiza todos os LinkedEntityCellValue objetos de todos os domínios de dados de entidades ligadas nesta coleção. O pedido de atualização pode falhar se os fornecedores de dados estiverem ocupados ou temporariamente inacessíveis.

refreshAll(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

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

toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;

Retornos

Excel.Interfaces.LinkedEntityDataDomainCollectionData

Detalhes do evento

onLinkedEntityDataDomainAdded

Ocorre quando um novo domínio de dados de entidade ligada é adicionado ao livro.

readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

onRefreshCompleted

Ocorre quando o pedido de atualização LinkedEntityCellValue de objetos de um domínio de dados de entidade ligada é concluído.

readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

onRefreshModeChanged

Ocorre quando o refreshMode de um domínio de dados de entidade ligada é alterado.

readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.19 ]