Excel.LinkedEntityDataDomainRefreshCompletedEventArgs interface

Paquet:
excel

Fournit des informations sur le domaine de données d’entité liée dont LinkedEntityCellValue les objets ont été actualisés.

Remarques

Jeu d’API : ExcelApi 1.19

Cette interface n’est pas prise en charge dans Excel sur le Web.

Utilisateur

Exemples

// 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}`);
}

Propriétés

errors

Obtient toutes les erreurs rencontrées lors de la demande d’actualisation LinkedEntityCellValue des objets du domaine de données de l’entité liée.
id

Obtient l’ID du domaine de données d’entité lié dont LinkedEntityCellValue les objets ont été actualisés. Cet ID est défini par les compléments Office. Cet ID ne s’applique pas aux domaines de données d’entité liés définis par des fournisseurs de données de service, tels que Bing ou Power BI.
refreshed

Renvoie true si les LinkedEntityCellValue objets du domaine de données d’entité lié ont été actualisés correctement. Sinon, retourne false.
serviceId

Obtient l’ID de service du domaine de données d’entité lié dont LinkedEntityCellValue les objets ont été actualisés.
source

Obtient la source de l’événement. Pour Excel.EventSource plus de détails.
type

Obtient le type de l’événement. Pour Excel.EventType plus de détails.

Détails de la propriété

errors

Obtient toutes les erreurs rencontrées lors de la demande d’actualisation LinkedEntityCellValue des objets du domaine de données de l’entité liée.

errors?: string[];

Valeur de propriété

string[]

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

id

Obtient l’ID du domaine de données d’entité lié dont LinkedEntityCellValue les objets ont été actualisés. Cet ID est défini par les compléments Office. Cet ID ne s’applique pas aux domaines de données d’entité liés définis par des fournisseurs de données de service, tels que Bing ou Power BI.

id?: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

refreshed

Renvoie true si les LinkedEntityCellValue objets du domaine de données d’entité lié ont été actualisés correctement. Sinon, retourne false.

refreshed: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

serviceId

Obtient l’ID de service du domaine de données d’entité lié dont LinkedEntityCellValue les objets ont été actualisés.

serviceId: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

source

Obtient la source de l’événement. Pour Excel.EventSource plus de détails.

source: Excel.EventSource | "Local" | "Remote";

Valeur de propriété

Excel.EventSource | "Local" | "Remote"

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

type

Obtient le type de l’événement. Pour Excel.EventType plus de détails.

type: "LinkedEntityDataDomainRefreshCompleted";

Valeur de propriété

"LinkedEntityDataDomainRefreshCompleted"

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.