Excel.LinkedEntityDataDomainRefreshCompletedEventArgs interface

LinkedEntityCellValue オブジェクトが更新されたリンクされたエンティティ データ ドメインに関する情報を提供します。

注釈

API セット: ExcelApi 1.19

このインターフェイスは、Excel on the web ではサポートされていません。

使用元

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

プロパティ

errors

リンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトを更新要求中に発生したエラーを取得します。

id

LinkedEntityCellValue オブジェクトが更新されたリンクされたエンティティ データ ドメインの ID を取得します。 この ID は Office アドインによって定義されます。この ID は、Bing や Power BI などのサービス データ プロバイダーによって定義されたリンクされたエンティティ データ ドメインには適用されません。

refreshed

リンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトが正常に更新された場合は true を返し、それ以外の場合はfalseを返します。

serviceId

LinkedEntityCellValue オブジェクトが更新されたリンクされたエンティティ データ ドメインのサービス ID を取得します。

source

イベントのソースを取得します。 詳細は「Excel.EventSource」をご覧ください。

type

イベントの種類を取得します。 詳細は「Excel.EventType」をご覧ください。

プロパティの詳細

errors

リンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトを更新要求中に発生したエラーを取得します。

errors?: string[];

プロパティ値

string[]

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

id

LinkedEntityCellValue オブジェクトが更新されたリンクされたエンティティ データ ドメインの ID を取得します。 この ID は Office アドインによって定義されます。この ID は、Bing や Power BI などのサービス データ プロバイダーによって定義されたリンクされたエンティティ データ ドメインには適用されません。

id?: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

refreshed

リンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトが正常に更新された場合は true を返し、それ以外の場合はfalseを返します。

refreshed: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

serviceId

LinkedEntityCellValue オブジェクトが更新されたリンクされたエンティティ データ ドメインのサービス ID を取得します。

serviceId: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

source

イベントのソースを取得します。 詳細は「Excel.EventSource」をご覧ください。

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

プロパティ値

Excel.EventSource | "Local" | "Remote"

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

type

イベントの種類を取得します。 詳細は「Excel.EventType」をご覧ください。

type: "LinkedEntityDataDomainRefreshCompleted";

プロパティ値

"LinkedEntityDataDomainRefreshCompleted"

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。