Excel.LinkedEntityDataDomainCollection class
Representa uma coleção de LinkedEntityDataDomain objetos. A coleção pode conter domínios de dados de entidade vinculados, como ações, geografia ou moedas definidas por provedores de dados de serviço, como Bing ou Power BI, ou domínios de dados de entidade vinculados definidos por Suplementos do Office.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.19]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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 vinculado definido pelo Suplemento do Office à coleção. Depois que o domínio de dados da entidade vinculada é adicionado, ele pode ser usado para criar |
| get |
Obtém o número de domínios de dados de entidades vinculadas na coleção. |
| get |
Obtém um domínio de dados de entidade vinculado por seu |
| get |
Obtém um domínio de dados de entidade vinculado por seu índice na coleção. |
| get |
Obtém um domínio de dados de entidade vinculado por seu |
| get |
Obtém um domínio de dados de entidade vinculado por seu |
| get |
Obtém um domínio de dados de entidade vinculado por seu |
| 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 |
| load |
Envia uma solicitação para carregar o |
| refresh |
Atualiza todos os |
| toJSON() | Substitui o método JavaScript |
Eventos
| on |
Ocorre quando a solicitação para carregar um |
| on |
Ocorre quando um novo domínio de dados de entidade vinculada é adicionado à pasta de trabalho. |
| on |
Ocorre quando a solicitação para atualizar |
| on |
Ocorre quando o |
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
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 vinculado definido pelo Suplemento do Office à coleção. Depois que o domínio de dados da entidade vinculada é adicionado, ele pode ser usado para criar LinkedEntityCellValue objetos.
add(options: Excel.LinkedEntityDataDomainCreateOptions): void;Parâmetros
Opções usadas para criar o domínio de dados da entidade vinculada a ser adicionado.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.19]
getCount()
Obtém o número de domínios de dados de entidades vinculadas na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
[Conjunto de apis: ExcelApi 1.19]
getItem(id)
Obtém um domínio de dados de entidade vinculado por seu id.
getItem(id: string): Excel.LinkedEntityDataDomain;Parâmetros
- id
-
string
O id do LinkedEntityDataDomain objeto a ser recuperado.
Retornos
O domínio de dados da entidade vinculada com o arquivo .id Se houver vários domínios de dados de entidade vinculados com o mesmo id, o definido por esse suplemento do Office será retornado.
Comentários
[Conjunto de apis: ExcelApi 1.19]
getItemAt(index)
Obtém um domínio de dados de entidade vinculado por seu índice na coleção.
getItemAt(index: number): Excel.LinkedEntityDataDomain;Parâmetros
- index
-
number
O índice do domínio de dados da entidade vinculada na coleção.
Retornos
O domínio de dados da entidade vinculada no índice fornecido.
Comentários
[Conjunto de apis: ExcelApi 1.19]
getItemByName(name)
Obtém um domínio de dados de entidade vinculado por seu name.
getItemByName(name: string): Excel.LinkedEntityDataDomain;Parâmetros
- name
-
string
O name do LinkedEntityDataDomain objeto a ser recuperado.
Retornos
O domínio de dados da entidade vinculada com o arquivo .name Se houver vários domínios de dados de entidade vinculados com o mesmo name, o definido por esse suplemento do Office será retornado.
Comentários
[Conjunto de apis: ExcelApi 1.19]
getItemByNameOrNullObject(name)
Obtém um domínio de dados de entidade vinculado por seu name. Se o domínio de dados da entidade vinculada 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.
getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;Parâmetros
- name
-
string
O name do LinkedEntityDataDomain objeto a ser recuperado.
Retornos
O domínio de dados da entidade vinculada com o arquivo .name Se houver vários domínios de dados de entidade vinculados com o mesmo name, o definido por esse suplemento do Office será retornado.
Comentários
[Conjunto de apis: ExcelApi 1.19]
getItemOrNullObject(id)
Obtém um domínio de dados de entidade vinculado por seu id. Se o domínio de dados da entidade vinculada 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(id: string): Excel.LinkedEntityDataDomain;Parâmetros
- id
-
string
O id do LinkedEntityDataDomain objeto a ser recuperado.
Retornos
O domínio de dados da entidade vinculada com o arquivo .id Se houver vários domínios de dados de entidade vinculados com o mesmo id, o definido por esse suplemento do Office será retornado.
Comentários
[Conjunto de apis: 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 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.LinkedEntityDataDomainCollection;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.LinkedEntityDataDomainCollection;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
loadLinkedEntityCellValue(id)
Envia uma solicitação para carregar o LinkedEntityCellValue objeto com o arquivo .LinkedEntityId Se encontrado, o LinkedEntityCellValue objeto será retornado por meio do LinkedEntityCellValueLoaded evento.
loadLinkedEntityCellValue(id: LinkedEntityId): void;Parâmetros
Um específico LinkedEntityId
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.21]
refreshAll()
Atualiza todos os LinkedEntityCellValue objetos de todos os domínios de dados de entidades vinculadas nesta coleção. A solicitação de atualização poderá falhar se os provedores de dados estiverem ocupados ou temporariamente inacessíveis.
refreshAll(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.19]
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.LinkedEntityDataDomainCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.LinkedEntityDataDomainCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;Retornos
Detalhes do evento
onLinkedEntityCellValueLoaded
Ocorre quando a solicitação para carregar um LinkedEntityCellValue é concluída.
readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers<Excel.LinkedEntityCellValueLoadedEventArgs>;Tipo de Evento
Comentários
[Conjunto de apis: ExcelApi 1.21]
Este evento não tem suporte no Excel na Web.
onLinkedEntityDataDomainAdded
Ocorre quando um novo domínio de dados de entidade vinculada é adicionado à pasta de trabalho.
readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;Tipo de Evento
Comentários
[Conjunto de apis: ExcelApi 1.19]
onRefreshCompleted
Ocorre quando a solicitação para atualizar LinkedEntityCellValue objetos de um domínio de dados de entidade vinculada é concluída.
readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;Tipo de Evento
Comentários
[Conjunto de apis: ExcelApi 1.19]
onRefreshModeChanged
Ocorre quando o refreshMode domínio de dados de uma entidade vinculada é alterado.
readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;Tipo de Evento
Comentários
[Conjunto de apis: ExcelApi 1.19]