Excel.LinkedEntityDataDomainCollection class

Paquete:

excel

Representa una colección de LinkedEntityDataDomain objetos. La colección puede contener dominios de datos de entidad vinculados, como existencias, geografía o monedas definidas por proveedores de datos de servicio, como Bing o Power BI, o dominios de datos de entidad vinculada definidos por complementos de Office.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
items	Obtiene los elementos secundarios cargados en esta colección.

Métodos

add(options)	Agrega un objeto de dominio de datos de entidad vinculada definido por el complemento de Office a la colección. Una vez agregado el dominio de datos de la entidad vinculada, se puede usar para crear LinkedEntityCellValue objetos.
getCount()	Obtiene el número de dominios de datos de entidad vinculada de la colección.
getItem(id)	Obtiene un dominio de datos de entidad vinculado por su id.
getItemAt(index)	Obtiene un dominio de datos de entidad vinculada por su índice en la colección.
getItemByName(name)	Obtiene un dominio de datos de entidad vinculado por su name.
getItemByNameOrNullObject(name)	Obtiene un dominio de datos de entidad vinculado 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 *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getItemOrNullObject(id)	Obtiene un dominio de datos de entidad vinculado 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 *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
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(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
refreshAll()	Actualiza todos los LinkedEntityCellValue objetos de todos los dominios de datos de entidad vinculada de esta colección. La solicitud de actualización puede producir un error si los proveedores de datos están ocupados o temporalmente inaccesibles.
toJSON()	Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.LinkedEntityDataDomainCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LinkedEntityDataDomainCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

Eventos

onLinkedEntityDataDomainAdded	Se produce cuando se agrega un nuevo dominio de datos de entidad vinculada al libro.
onRefreshCompleted	Se produce cuando se completa la solicitud para actualizar LinkedEntityCellValue objetos de un dominio de datos de entidad vinculada.
onRefreshModeChanged	Se produce cuando se cambia el refreshMode de un dominio de datos de entidad vinculada.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.LinkedEntityDataDomain[];

Valor de propiedad

Excel.LinkedEntityDataDomain[]

Detalles del método

add(options)

Agrega un objeto de dominio de datos de entidad vinculada definido por el complemento de Office a la colección. Una vez agregado el dominio de datos de la entidad vinculada, se puede usar para crear LinkedEntityCellValue objetos.

add(options: Excel.LinkedEntityDataDomainCreateOptions): void;

Parámetros

options

Excel.LinkedEntityDataDomainCreateOptions

Opciones que se usan para crear el dominio de datos de 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 vinculada 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 vinculado por su id.

getItem(id: string): Excel.LinkedEntityDataDomain;

Parámetros

id

string

id del LinkedEntityDataDomain objeto que se va a recuperar.

Devoluciones

Excel.LinkedEntityDataDomain

Dominio de datos de entidad vinculada con el especificado id. Si hay varios dominios de datos de entidad vinculada 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

Índice del dominio de datos de entidad vinculada de la colección.

Devoluciones

Excel.LinkedEntityDataDomain

Dominio de datos de entidad vinculada en el índice especificado.

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

getItemByName(name)

Obtiene un dominio de datos de entidad vinculado por su name.

getItemByName(name: string): Excel.LinkedEntityDataDomain;

Parámetros

name

string

name del LinkedEntityDataDomain objeto que se va a recuperar.

Devoluciones

Excel.LinkedEntityDataDomain

Dominio de datos de entidad vinculada con el especificado name. Si hay varios dominios de datos de entidad vinculada 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 vinculado 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 *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;

Parámetros

name

string

name del LinkedEntityDataDomain objeto que se va a recuperar.

Devoluciones

Excel.LinkedEntityDataDomain

Dominio de datos de entidad vinculada con el especificado name. Si hay varios dominios de datos de entidad vinculada 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 vinculado 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 *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;

Parámetros

id

string

id del LinkedEntityDataDomain objeto que se va a recuperar.

Devoluciones

Excel.LinkedEntityDataDomain

Dominio de datos de entidad vinculada con el especificado id. Si hay varios dominios de datos de entidad vinculada 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

Excel.LinkedEntityDataDomainCollection

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

Excel.LinkedEntityDataDomainCollection

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

Excel.LinkedEntityDataDomainCollection

refreshAll()

Actualiza todos los LinkedEntityCellValue objetos de todos los dominios de datos de entidad vinculada de esta colección. La solicitud de actualización puede producir un error si los proveedores de datos están ocupados o temporalmente inaccesibles.

refreshAll(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.LinkedEntityDataDomainCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LinkedEntityDataDomainCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;

Devoluciones

Excel.Interfaces.LinkedEntityDataDomainCollectionData

Detalles del evento

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

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>

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

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>

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

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]