Excel.LinkedEntityDataDomainCollection class

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.LinkedEntityDataDomain[];

Valeur de propriété

Ajoute à la collection un objet de domaine de données d’entité lié défini par le complément Office. Une fois le domaine de données d’entité liée ajouté, il peut être utilisé pour créer LinkedEntityCellValue des objets.

add(options: Excel.LinkedEntityDataDomainCreateOptions): void;

Paramètres

Retours

Remarques

Ensemble d’API : ExcelApi 1.19

Cette méthode n’est pas prise en charge dans Excel sur le Web.

Obtient le nombre de domaines de données d’entité liés dans la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

Ensemble d’API : ExcelApi 1.19

Cette méthode n’est pas prise en charge dans Excel sur le Web.

Obtient un domaine de données d’entité liée par son id.

getItem(id: string): Excel.LinkedEntityDataDomain;

Paramètres

Retours

Domaine de données d’entité liée avec le donné id. S’il existe plusieurs domaines de données d’entité liés avec le même id, celui défini par ce complément Office est retourné.

Remarques

Ensemble d’API : ExcelApi 1.19

Cette méthode n’est pas prise en charge dans Excel sur le Web.

Obtient un domaine de données d’entité liée par son index dans la collection.

getItemAt(index: number): Excel.LinkedEntityDataDomain;

Paramètres

Retours

Domaine de données d’entité liée à l’index donné.

Remarques

Ensemble d’API : ExcelApi 1.19

Cette méthode n’est pas prise en charge dans Excel sur le Web.

Obtient un domaine de données d’entité liée par son name.

getItemByName(name: string): Excel.LinkedEntityDataDomain;

Paramètres

Retours

Domaine de données d’entité liée avec le donné name. S’il existe plusieurs domaines de données d’entité liés avec le même name, celui défini par ce complément Office est retourné.

Remarques

Ensemble d’API : ExcelApi 1.19

Cette méthode n’est pas prise en charge dans Excel sur le Web.

Obtient un domaine de données d’entité liée par son name. Si le domaine de données d’entité liée n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;

Paramètres

Retours

Domaine de données d’entité liée avec le donné name. S’il existe plusieurs domaines de données d’entité liés avec le même name, celui défini par ce complément Office est retourné.

Remarques

Ensemble d’API : ExcelApi 1.19

Cette méthode n’est pas prise en charge dans Excel sur le Web.

Obtient un domaine de données d’entité liée par son id. Si le domaine de données d’entité liée n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;

Paramètres

Retours

Domaine de données d’entité liée avec le donné id. S’il existe plusieurs domaines de données d’entité liés avec le même id, celui défini par ce complément Office est retourné.

Remarques

Ensemble d’API : ExcelApi 1.19

Cette méthode n’est pas prise en charge dans Excel sur le Web.

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomainCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;

Paramètres

Retours

Envoie une demande pour charger l’objet LinkedEntityCellValue avec le spécifié LinkedEntityId. S’il est trouvé, l’objet LinkedEntityCellValue est retourné par le biais de l’événement LinkedEntityCellValueLoaded .

loadLinkedEntityCellValue(id: LinkedEntityId): void;

Paramètres

Retours

Remarques

Ensemble d’API : ExcelApi 1.21

Exemples

// Loads the linked entity cell value for the specified domain and entity IDs.
async function loadLinkedEntity(domainId: string, entityId: string ) {
    await Excel.run(async (context) => {
        // Specify the linked entity ID to load.
        const linkedEntityId: Excel.LinkedEntityId = {
            entityId: entityId,
            domainId: domainId,
            serviceId: 268436224, // Service ID used by Excel to identify linked entity cell values associated with an add-in.
            culture: "en-US",
        };

        // Load the linked entity cell value.
        context.workbook.linkedEntityDataDomains.loadLinkedEntityCellValue(linkedEntityId);
        await context.sync();

        // The onLinkedEntityCellValueLoaded event occurs once the linked entity cell value is loaded.
    });
}

Actualise tous les LinkedEntityCellValue objets de tous les domaines de données d’entité liée dans cette collection. La demande d’actualisation peut échouer si les fournisseurs de données sont occupés ou temporairement inaccessibles.

refreshAll(): void;

Retours

Remarques

Ensemble d’API : ExcelApi 1.19

Cette méthode n’est pas prise en charge dans Excel sur le Web.

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.LinkedEntityDataDomainCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.LinkedEntityDataDomainCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;

Retours

Se produit lorsque la demande de chargement d’un LinkedEntityCellValue est terminée.

readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers<Excel.LinkedEntityCellValueLoadedEventArgs>;

Type d’événement

Remarques

Ensemble d’API : ExcelApi 1.21

Cet événement n’est pas pris en charge dans Excel sur le Web.

Exemples

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

        await context.sync();
        console.log("Event handler registered successfully. You''ll be notified when linked entities are loaded.");
    });
}

// Handles the onLinkedEntityCellValueLoaded event that occurs when a linked entity cell value is loaded.
async function handleLoadedLinkedEntity(event: Excel.LinkedEntityCellValueLoadedEventArgs) {
    await Excel.run(async (context) => {
        console.log(`The ${event.type} event occurred from a ${event.source} source.`);
        console.log(`The linked entity cell value with ID ${event.id} is loaded.`);
        const loadedLinkedEntityCellValue: Excel.LinkedEntityCellValue = event.linkedEntityCellValue;
        console.log(`Loaded linked entity cell value: ${loadedLinkedEntityCellValue}`);

        // Queue operations on the loaded entity value here.

        await context.sync();
    });
}

Se produit lorsqu’un nouveau domaine de données d’entité liée est ajouté au classeur.

readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;

Type d’événement

Remarques

Ensemble d’API : ExcelApi 1.19

Cet événement n’est pas pris en charge dans Excel sur le Web.

Se produit lorsque la demande d’actualisation LinkedEntityCellValue des objets d’un domaine de données d’entité liée est terminée.

readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;

Type d’événement

Remarques

Ensemble d’API : ExcelApi 1.19

Cet événement n’est pas pris en charge dans Excel sur le Web.

Se produit lorsque le refreshMode d’un domaine de données d’entité liée est modifié.

readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;

Type d’événement

Remarques

Ensemble d’API : ExcelApi 1.19

Cet événement n’est pas pris en charge dans Excel sur le Web.