Excel.LinkedEntityCellValueLoadedEventArgs interface

Пакет:

excel

Предоставляет сведения о запрошенном объекте LinkedEntityCellValue с заданным LinkedEntityIdзначением .

Комментарии

Набор API: ExcelApi 1.21

Используется

• Excel.LinkedEntityDataDomainCollection: onLinkedEntityCellValueLoaded

Примеры

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

Свойства

error	Любая ошибка, возникаемая во время запроса на загрузку LinkedEntityCellValue.
id	Возвращает значение LinkedEntityId запрошенного LinkedEntityCellValueобъекта .
linkedEntityCellValue	Возвращает значение LinkedEntityCellValue запрошенного LinkedEntityIdобъекта . Если операция загрузки завершилась ошибкой, это свойство имеет значение null.
source	Получает источник события. Дополнительные сведения см. в этой Excel.EventSource статье.
type	Получает тип события. Дополнительные сведения см. в этой Excel.EventType статье.

Сведения о свойстве

error

Любая ошибка, возникаемая во время запроса на загрузку LinkedEntityCellValue.

error?: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.21

id

Возвращает значение LinkedEntityId запрошенного LinkedEntityCellValueобъекта .

id: LinkedEntityId;

Значение свойства

Excel.LinkedEntityId

Комментарии

Набор API: ExcelApi 1.21

linkedEntityCellValue

Возвращает значение LinkedEntityCellValue запрошенного LinkedEntityIdобъекта . Если операция загрузки завершилась ошибкой, это свойство имеет значение null.

linkedEntityCellValue?: LinkedEntityCellValue;

Значение свойства

Excel.LinkedEntityCellValue

Комментарии

Набор API: ExcelApi 1.21

source

Получает источник события. Дополнительные сведения см. в этой Excel.EventSource статье.

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

Значение свойства

Excel.EventSource | "Local" | "Remote"

Комментарии

Набор API: ExcelApi 1.21

type

Получает тип события. Дополнительные сведения см. в этой Excel.EventType статье.

type: "LinkedEntityDataDomainLinkedEntityCellValueLoaded";

Значение свойства

"LinkedEntityDataDomainLinkedEntityCellValueLoaded"

Комментарии

Набор API: ExcelApi 1.21