Excel.LinkedEntityDataDomainCollection class
Representa una colección de LinkedEntityDataDomain objetos. La colección puede contener dominios de datos de entidad vinculada, como cotizaciones, geografía o monedas, definidos por proveedores de datos de servicios, como Bing o Power BI, o dominios de datos de entidad vinculados definidos por complementos de Office.
- Extends
Comentarios
[Conjunto de API: ExcelApi 1.19]
Propiedades
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(options) | Agrega a la colección un objeto de dominio de datos de entidad vinculada definido por el complemento de Office. Una vez agregado el dominio de datos de la entidad vinculada, se puede utilizar para crear |
| get |
Obtiene el número de dominios de datos de entidad vinculados de la colección. |
| get |
Obtiene un dominio de datos de entidad vinculada por su |
| get |
Obtiene un dominio de datos de entidad vinculada por su índice en la colección. |
| get |
Obtiene un dominio de datos de entidad vinculada por su |
| get |
Obtiene un dominio de datos de entidad vinculada por su |
| get |
Obtiene un dominio de datos de entidad vinculada por su |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load |
Envía una solicitud para cargar el |
| refresh |
Actualiza todos los |
| toJSON() | Reemplaza el método JavaScript |
Eventos
| on |
Se produce cuando se completa la solicitud para cargar a |
| on |
Se produce cuando se agrega un nuevo dominio de datos de entidad vinculada al libro. |
| on |
Se produce cuando se completa la solicitud para actualizar |
| on |
Se produce cuando se cambia el |
Detalles de las propiedades
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.LinkedEntityDataDomain[];Valor de propiedad
Detalles del método
add(options)
Agrega a la colección un objeto de dominio de datos de entidad vinculada definido por el complemento de Office. Una vez agregado el dominio de datos de la entidad vinculada, se puede utilizar para crear LinkedEntityCellValue objetos.
add(options: Excel.LinkedEntityDataDomainCreateOptions): void;Parámetros
Opciones que se usan para crear el dominio de datos de la entidad vinculada que se va a agregar.
Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.19]
getCount()
Obtiene el número de dominios de datos de entidad vinculados de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
[Conjunto de API: ExcelApi 1.19]
getItem(id)
Obtiene un dominio de datos de entidad vinculada por su id.
getItem(id: string): Excel.LinkedEntityDataDomain;Parámetros
- id
-
string
Del idLinkedEntityDataDomain objeto que se va a recuperar.
Devoluciones
El dominio de datos de la entidad vinculada con el idarchivo . Si hay varios dominios de datos de entidades vinculadas con el mismo id, se devolverá el definido por este complemento de Office.
Comentarios
[Conjunto de API: ExcelApi 1.19]
getItemAt(index)
Obtiene un dominio de datos de entidad vinculada por su índice en la colección.
getItemAt(index: number): Excel.LinkedEntityDataDomain;Parámetros
- index
-
number
El índice del dominio de datos de la entidad vinculada en la colección.
Devoluciones
El dominio de datos de la entidad vinculada en el índice especificado.
Comentarios
[Conjunto de API: ExcelApi 1.19]
getItemByName(name)
Obtiene un dominio de datos de entidad vinculada por su name.
getItemByName(name: string): Excel.LinkedEntityDataDomain;Parámetros
- name
-
string
Del nameLinkedEntityDataDomain objeto que se va a recuperar.
Devoluciones
El dominio de datos de la entidad vinculada con el namearchivo . Si hay varios dominios de datos de entidades vinculadas con el mismo name, se devolverá el definido por este complemento de Office.
Comentarios
[Conjunto de API: ExcelApi 1.19]
getItemByNameOrNullObject(name)
Obtiene un dominio de datos de entidad vinculada por su name. Si el dominio de datos de la entidad vinculada no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.
getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;Parámetros
- name
-
string
Del nameLinkedEntityDataDomain objeto que se va a recuperar.
Devoluciones
El dominio de datos de la entidad vinculada con el namearchivo . Si hay varios dominios de datos de entidades vinculadas con el mismo name, se devolverá el definido por este complemento de Office.
Comentarios
[Conjunto de API: ExcelApi 1.19]
getItemOrNullObject(id)
Obtiene un dominio de datos de entidad vinculada por su id. Si el dominio de datos de la entidad vinculada no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.
getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;Parámetros
- id
-
string
Del idLinkedEntityDataDomain objeto que se va a recuperar.
Devoluciones
El dominio de datos de la entidad vinculada con el idarchivo . Si hay varios dominios de datos de entidades vinculadas con el mismo id, se devolverá el definido por este complemento de Office.
Comentarios
[Conjunto de API: ExcelApi 1.19]
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection;Parámetros
- options
-
Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomainCollection;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;Parámetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
loadLinkedEntityCellValue(id)
Envía una solicitud para cargar el LinkedEntityCellValue objeto con el archivo .LinkedEntityId Si se encuentra, el LinkedEntityCellValue objeto se devolverá a través del LinkedEntityCellValueLoaded evento.
loadLinkedEntityCellValue(id: LinkedEntityId): void;Parámetros
Un LinkedEntityId
Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.21]
refreshAll()
Actualiza todos los LinkedEntityCellValue objetos de todos los dominios de datos de entidades vinculadas de esta colección. Se puede producir un error en la solicitud de actualización si los proveedores de datos están ocupados o no se puede acceder a ellos temporalmente.
refreshAll(): void;Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.19]
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.LinkedEntityDataDomainCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.LinkedEntityDataDomainCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.
toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;Devoluciones
Detalles del evento
onLinkedEntityCellValueLoaded
Se produce cuando se completa la solicitud para cargar a LinkedEntityCellValue .
readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers<Excel.LinkedEntityCellValueLoadedEventArgs>;Tipo de evento
Comentarios
[Conjunto de API: ExcelApi 1.21]
Este evento no se admite en Excel en la Web.
onLinkedEntityDataDomainAdded
Se produce cuando se agrega un nuevo dominio de datos de entidad vinculada al libro.
readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;Tipo de evento
Comentarios
[Conjunto de API: ExcelApi 1.19]
onRefreshCompleted
Se produce cuando se completa la solicitud para actualizar LinkedEntityCellValue objetos de un dominio de datos de entidad vinculada.
readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;Tipo de evento
Comentarios
[Conjunto de API: ExcelApi 1.19]
onRefreshModeChanged
Se produce cuando se cambia el refreshMode de un dominio de datos de entidad vinculada.
readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;Tipo de evento
Comentarios
[Conjunto de API: ExcelApi 1.19]