Excel.LinkedEntityDataDomainCollection class
LinkedEntityDataDomain オブジェクトのコレクションを表します。 コレクションには、Bingや Power BI などのサービス データ プロバイダーによって定義された株式、地域、通貨などのリンクされたエンティティ データ ドメイン、または Office アドインによって定義されたリンクされたエンティティ データ ドメインを含めることができます。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(options) | Office アドインによって定義されたリンクされたエンティティ データ ドメイン オブジェクトをコレクションに追加します。 リンクされたエンティティ データ ドメインが追加されると、それを使用して |
| get |
コレクション内のリンクされたエンティティ データ ドメインの数を取得します。 |
| get |
|
| get |
コレクション内のインデックスによってリンクされたエンティティ データ ドメインを取得します。 |
| get |
|
| get |
|
| get |
|
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| refresh |
このコレクション内のすべてのリンクされたエンティティ データ ドメインのすべての |
| toJSON() | API オブジェクトが |
イベント
| on |
新しいリンク エンティティ データ ドメインがブックに追加されたときに発生します。 |
| on |
リンクされたエンティティ データ ドメインのオブジェクト |
| on |
リンクされたエンティティ データ ドメインの |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
このコレクション内に読み込まれた子アイテムを取得します。
readonly items: Excel.LinkedEntityDataDomain[];プロパティ値
メソッドの詳細
add(options)
Office アドインによって定義されたリンクされたエンティティ データ ドメイン オブジェクトをコレクションに追加します。 リンクされたエンティティ データ ドメインが追加されると、それを使用して LinkedEntityCellValue オブジェクトを作成できます。
add(options: Excel.LinkedEntityDataDomainCreateOptions): void;パラメーター
追加するリンクされたエンティティ データ ドメインの作成に使用されるオプション。
戻り値
void
注釈
getCount()
コレクション内のリンクされたエンティティ データ ドメインの数を取得します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
注釈
getItem(id)
id
によってリンクされたエンティティ データ ドメインを取得します。
getItem(id: string): Excel.LinkedEntityDataDomain;パラメーター
- id
-
string
取得するLinkedEntityDataDomain オブジェクトのid。
戻り値
指定された idを持つリンクされたエンティティ データ ドメイン。 同じ idを持つ複数のリンクされたエンティティ データ ドメインがある場合は、この Office アドインによって定義されたドメインが返されます。
注釈
getItemAt(index)
コレクション内のインデックスによってリンクされたエンティティ データ ドメインを取得します。
getItemAt(index: number): Excel.LinkedEntityDataDomain;パラメーター
- index
-
number
コレクション内のリンクされたエンティティ データ ドメインのインデックス。
戻り値
指定されたインデックスにあるリンクされたエンティティ データ ドメイン。
注釈
getItemByName(name)
name
によってリンクされたエンティティ データ ドメインを取得します。
getItemByName(name: string): Excel.LinkedEntityDataDomain;パラメーター
- name
-
string
取得するLinkedEntityDataDomain オブジェクトのname。
戻り値
指定された nameを持つリンクされたエンティティ データ ドメイン。 同じ nameを持つ複数のリンクされたエンティティ データ ドメインがある場合は、この Office アドインによって定義されたドメインが返されます。
注釈
getItemByNameOrNullObject(name)
name
によってリンクされたエンティティ データ ドメインを取得します。 リンクされたエンティティ データ ドメインが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;パラメーター
- name
-
string
取得するLinkedEntityDataDomain オブジェクトのname。
戻り値
指定された nameを持つリンクされたエンティティ データ ドメイン。 同じ nameを持つ複数のリンクされたエンティティ データ ドメインがある場合は、この Office アドインによって定義されたドメインが返されます。
注釈
getItemOrNullObject(id)
id
によってリンクされたエンティティ データ ドメインを取得します。 リンクされたエンティティ データ ドメインが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;パラメーター
- id
-
string
取得するLinkedEntityDataDomain オブジェクトのid。
戻り値
指定された idを持つリンクされたエンティティ データ ドメイン。 同じ idを持つ複数のリンクされたエンティティ データ ドメインがある場合は、この Office アドインによって定義されたドメインが返されます。
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection;パラメーター
- options
-
Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomainCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
refreshAll()
このコレクション内のすべてのリンクされたエンティティ データ ドメインのすべての LinkedEntityCellValue オブジェクトを更新します。 データ プロバイダーがビジー状態であるか、一時的にアクセスできない場合、更新要求が失敗する可能性があります。
refreshAll(): void;戻り値
void
注釈
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.LinkedEntityDataDomainCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.LinkedEntityDataDomainCollectionDataとして型指定) を返します。
toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;戻り値
イベントの詳細
onLinkedEntityDataDomainAdded
新しいリンク エンティティ データ ドメインがブックに追加されたときに発生します。
readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;イベントの種類
注釈
onRefreshCompleted
リンクされたエンティティ データ ドメインのオブジェクト LinkedEntityCellValue 更新する要求が完了したときに発生します。
readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;イベントの種類
注釈
onRefreshModeChanged
リンクされたエンティティ データ ドメインの refreshMode が変更されたときに発生します。
readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;