Excel.TableScopedCollection class

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

context: RequestContext;

プロパティ値

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

readonly items: Excel.Table[];

プロパティ値

コレクションに含まれるテーブルの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

コレクション内の最初のテーブルを取得します。 コレクション内のテーブルは、左上のテーブルがコレクションの最初のテーブルになるように、上から下、左から右に並べ替えられます。

getFirst(): Excel.Table;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

名前または ID でテーブルを取得します。

getItem(key: string): Excel.Table;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

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

getItemOrNullObject(key: string): Excel.Table;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.14 ]

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

load(options?: Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection;

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

toJSON(): Excel.Interfaces.TableScopedCollectionData;

戻り値