次の方法で共有

Excel.LinkedDataTypeCollection class

  • リファレンス
パッケージ:
excel

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

リンクされたデータ型のコレクションを表します。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

プロパティ

context

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

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

メソッド

getCount()

コレクション内のリンクされたデータ型の数を取得します。
getItem(key)

サービス ID 別のリンクされたデータ型を取得します。
getItemAt(index)

コレクション内のインデックスによってリンクされたデータ型を取得します。
getItemOrNullObject(key)

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

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

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

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

コレクション内のすべてのリンクされたデータ型を更新するように要求します。 サービスがビジー状態であるか、一時的にアクセスできない場合、要求は満たされません。
toJSON()

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

プロパティの詳細

context

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

context: RequestContext;

プロパティ値

Excel.RequestContext

items

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

readonly items: Excel.LinkedDataType[];

プロパティ値

Excel.LinkedDataType[]

メソッドの詳細

getCount()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

コレクション内のリンクされたデータ型の数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

getItem(key)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

サービス ID 別のリンクされたデータ型を取得します。

getItem(key: number): Excel.LinkedDataType;

パラメーター

key

number

リンクされたデータ型の ID。

戻り値

Excel.LinkedDataType

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

getItemAt(index)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

getItemAt(index: number): Excel.LinkedDataType;

パラメーター

index

number

コレクション内のリンクされたデータ型オブジェクトのインデックス。

戻り値

Excel.LinkedDataType

指定されたインデックスにあるリンクされたデータ型。

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

getItemOrNullObject(key)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

getItemOrNullObject(key: number): Excel.LinkedDataType;

パラメーター

key

number

リンクされたデータ型のサービス ID。

戻り値

Excel.LinkedDataType

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

load(options)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

load(options?: Excel.Interfaces.LinkedDataTypeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedDataTypeCollection;

パラメーター

options

Excel.Interfaces.LinkedDataTypeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.LinkedDataTypeCollection

load(propertyNames)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.LinkedDataTypeCollection

load(propertyNamesAndPaths)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

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

パラメーター

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.LinkedDataTypeCollection

requestRefreshAll()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

コレクション内のすべてのリンクされたデータ型を更新するように要求します。 サービスがビジー状態であるか、一時的にアクセスできない場合、要求は満たされません。

requestRefreshAll(): void;

戻り値

void

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

toJSON()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

toJSON(): Excel.Interfaces.LinkedDataTypeCollectionData;

戻り値

Excel.Interfaces.LinkedDataTypeCollectionData