Excel.LinkedEntityDataDomainCollection class

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Excel.LinkedEntityDataDomain[];

プロパティ値

Office アドインによって定義されたリンクされたエンティティ データ ドメイン オブジェクトをコレクションに追加します。 リンクされたエンティティ データ ドメインが追加されると、それを使用して LinkedEntityCellValue オブジェクトを作成できます。

add(options: Excel.LinkedEntityDataDomainCreateOptions): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.19

このメソッドは、Excel on the webではサポートされていません。

コレクション内のリンクされたエンティティ データ ドメインの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

返品

注釈

API セット: ExcelApi 1.19

このメソッドは、Excel on the webではサポートされていません。

id によってリンクされたエンティティ データ ドメインを取得します。

getItem(id: string): Excel.LinkedEntityDataDomain;

パラメーター

返品

指定された idを持つリンクされたエンティティ データ ドメイン。 同じ idを持つ複数のリンクされたエンティティ データ ドメインがある場合は、この Office アドインによって定義されたドメインが返されます。

注釈

API セット: ExcelApi 1.19

このメソッドは、Excel on the webではサポートされていません。

コレクション内のインデックスによってリンクされたエンティティ データ ドメインを取得します。

getItemAt(index: number): Excel.LinkedEntityDataDomain;

パラメーター

返品

指定されたインデックスにあるリンクされたエンティティ データ ドメイン。

注釈

API セット: ExcelApi 1.19

このメソッドは、Excel on the webではサポートされていません。

name によってリンクされたエンティティ データ ドメインを取得します。

getItemByName(name: string): Excel.LinkedEntityDataDomain;

パラメーター

返品

指定された nameを持つリンクされたエンティティ データ ドメイン。 同じ nameを持つ複数のリンクされたエンティティ データ ドメインがある場合は、この Office アドインによって定義されたドメインが返されます。

注釈

API セット: ExcelApi 1.19

このメソッドは、Excel on the webではサポートされていません。

name によってリンクされたエンティティ データ ドメインを取得します。 リンクされたエンティティ データ ドメインが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;

パラメーター

返品

指定された nameを持つリンクされたエンティティ データ ドメイン。 同じ nameを持つ複数のリンクされたエンティティ データ ドメインがある場合は、この Office アドインによって定義されたドメインが返されます。

注釈

API セット: ExcelApi 1.19

このメソッドは、Excel on the webではサポートされていません。

id によってリンクされたエンティティ データ ドメインを取得します。 リンクされたエンティティ データ ドメインが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;

パラメーター

返品

指定された idを持つリンクされたエンティティ データ ドメイン。 同じ idを持つ複数のリンクされたエンティティ データ ドメインがある場合は、この Office アドインによって定義されたドメインが返されます。

注釈

API セット: ExcelApi 1.19

このメソッドは、Excel on the webではサポートされていません。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

指定したLinkedEntityIdを使用してLinkedEntityCellValue オブジェクトを読み込む要求を送信します。 見つかった場合、 LinkedEntityCellValue オブジェクトは、 LinkedEntityCellValueLoaded イベントを介して返されます。

loadLinkedEntityCellValue(id: LinkedEntityId): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.21

例

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

このコレクション内のすべてのリンクされたエンティティ データ ドメインのすべての LinkedEntityCellValue オブジェクトを更新します。 データ プロバイダーがビジー状態であるか、一時的にアクセスできない場合、更新要求が失敗する可能性があります。

refreshAll(): void;

返品

注釈

API セット: ExcelApi 1.19

このメソッドは、Excel on the webではサポートされていません。

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.LinkedEntityDataDomainCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.LinkedEntityDataDomainCollectionDataとして型指定) を返します。

toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;

返品

LinkedEntityCellValueを読み込む要求が完了したときに発生します。

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

イベントの種類

注釈

API セット: ExcelApi 1.21

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

例

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

新しいリンク エンティティ データ ドメインがブックに追加されたときに発生します。

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

イベントの種類

注釈

API セット: ExcelApi 1.19

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

リンクされたエンティティ データ ドメインのオブジェクト LinkedEntityCellValue 更新する要求が完了したときに発生します。

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

イベントの種類

注釈

API セット: ExcelApi 1.19

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

リンクされたエンティティ データ ドメインの refreshMode が変更されたときに発生します。

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

イベントの種類

注釈

API セット: ExcelApi 1.19

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