Excel.LinkedEntityDataDomainCollection class

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

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.LinkedEntityDataDomain[];

Valor de propiedad

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

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.19

Ejemplos

// Registers linked entity data domains when the add-in loads.
await Excel.run(async (context) => {
    const productsDomainOptions: Excel.LinkedEntityDataDomainCreateOptions = {
        dataProvider: "Contoso",
        id: "products",
        name: "Products",
        // ID of the custom function called by Excel to resolve or refresh linked entity cell values.
        loadFunctionId: "CONTOSOLOADSERVICE",
        // periodicRefreshInterval is only required when supportedRefreshModes contains "Periodic".
        periodicRefreshInterval: 300,
        // Manual refresh mode is always supported, even if unspecified.
        supportedRefreshModes: [
            Excel.LinkedEntityDataDomainRefreshMode.periodic,
            Excel.LinkedEntityDataDomainRefreshMode.onLoad
        ]
    };

    // Add the data domain to the collection to register it.
    context.workbook.linkedEntityDataDomains.add(productsDomainOptions);
    await context.sync();
});

Obtiene el número de dominios de datos de entidad vinculados de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.19

Obtiene un dominio de datos de entidad vinculada por su id.

getItem(id: string): Excel.LinkedEntityDataDomain;

Parámetros

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

Ejemplos

// Refreshes all linked entity cell values for a specific data domain.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;

    // Get a specific data domain by ID and refresh it.
    const productsDomain: Excel.LinkedEntityDataDomain = dataDomains.getItem("products");
    productsDomain.refresh();
    await context.sync();
});

Obtiene un dominio de datos de entidad vinculada por su índice en la colección.

getItemAt(index: number): Excel.LinkedEntityDataDomain;

Parámetros

Devoluciones

El dominio de datos de la entidad vinculada en el índice especificado.

Comentarios

Conjunto de API: ExcelApi 1.19

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

getItemByName(name: string): Excel.LinkedEntityDataDomain;

Parámetros

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

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

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

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

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

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

Devoluciones

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

Devoluciones

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

Devoluciones

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

Comentarios

Conjunto de API: ExcelApi 1.19

Ejemplos

// Refreshes all linked entity cell values across all data domains.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;

    // Refresh all linked entity cell values in all data domains.
    dataDomains.refreshAll();
    await context.sync();
});

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

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

Ejemplos

// Registers an event handler for the onLinkedEntityDataDomainAdded event.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
    dataDomains.onLinkedEntityDataDomainAdded.add(onDataDomainAdded);

    await context.sync();
});

async function onDataDomainAdded(eventArgs: Excel.LinkedEntityDataDomainAddedEventArgs): Promise<void> {
    console.log(`Linked entity data domain added: ${eventArgs.id}`);
    console.log(`Event type: ${eventArgs.type}`);
    console.log(`Event source: ${eventArgs.source}`);
    console.log(`Service ID: ${eventArgs.serviceId}`);
}

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

Ejemplos

// Registers an event handler for the onRefreshCompleted event.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
    dataDomains.onRefreshCompleted.add(onLinkedEntityDomainRefreshed);

    await context.sync();
});

async function onLinkedEntityDomainRefreshed(eventArgs: Excel.LinkedEntityDataDomainRefreshCompletedEventArgs): Promise<void> {
    console.log(`Linked entity domain refreshed: ${eventArgs.id}`);
    console.log(`Event type: ${eventArgs.type}`);
    console.log(`Event source: ${eventArgs.source}`);
    console.log(`Service ID: ${eventArgs.serviceId}`);
    console.log(`Refresh status: ${eventArgs.refreshed}`);
    console.log(`Refresh errors: ${eventArgs.errors}`);
}

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

Ejemplos

// Registers an event handler for the onRefreshModeChanged event.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
    dataDomains.onRefreshModeChanged.add(onRefreshModeChanged);

    await context.sync();
});

async function onRefreshModeChanged(eventArgs: Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs): Promise<void> {
    console.log(`Linked entity domain refresh mode changed: ${eventArgs.id}`);
    console.log(`Event type: ${eventArgs.type}`);
    console.log(`Event source: ${eventArgs.source}`);
    console.log(`Service ID: ${eventArgs.serviceId}`);
    console.log(`New refresh mode: ${eventArgs.refreshMode}`);
}