Excel.LinkedEntityDataDomainCollection class
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
Comentários
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 |
| get |
Obtém o número de domínios de dados de entidade ligados na coleção. |
| get |
Obtém um domínio de dados de entidade ligada pelo respetivo |
| get |
Obtém um domínio de dados de entidade ligada pelo respetivo índice na coleção. |
| get |
Obtém um domínio de dados de entidade ligada pelo respetivo |
| get |
Obtém um domínio de dados de entidade ligada pelo respetivo |
| get |
Obtém um domínio de dados de entidade ligada pelo respetivo |
| 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 |
| refresh |
Atualiza todos os |
| toJSON() | Substitui o método JavaScript |
Eventos
| on |
Ocorre quando um novo domínio de dados de entidade ligada é adicionado ao livro. |
| on |
Ocorre quando o pedido de atualização |
| on |
Ocorre quando 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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.LinkedEntityDataDomain[];Valor da propriedade
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
Opções que são utilizadas para criar o domínio de dados de entidade ligada a adicionar.
Retornos
void
Comentários
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
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
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
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
O domínio de dados da entidade ligada no índice especificado.
Comentários
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
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
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, 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).
getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;Parâmetros
- name
-
string
O name do LinkedEntityDataDomain objeto a ser obtido.
Retornos
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
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, 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(id: string): Excel.LinkedEntityDataDomain;Parâmetros
- id
-
string
O id do LinkedEntityDataDomain objeto a ser obtido.
Retornos
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
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
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
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
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
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
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
Comentários
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
Comentários
onRefreshModeChanged
Ocorre quando o refreshMode de um domínio de dados de entidade ligada é alterado.
readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;