Excel.TableCollection class

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

context: RequestContext;

プロパティ値

ブックに含まれるテーブルの数を返します。

readonly count: number;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

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

readonly items: Excel.Table[];

プロパティ値

新しいテーブルを作成します。 範囲オブジェクトまたはソース アドレスにより、テーブルが追加されるワークシートが判断されます。 テーブルが追加できない場合 (たとえば、アドレスが無効な場合や、テーブルが別のテーブルと重複している場合) は、エラーがスローされます。

add(address: Range | string, hasHeaders: boolean): Excel.Table;

パラメーター

返品

注釈

[API セット: ExcelApi 1.1]

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

getCount(): OfficeExtension.ClientResult<number>;

返品

注釈

[API セット: ExcelApi 1.4]

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

getItem(key: string): Excel.Table;

パラメーター

返品

注釈

[API セット: ExcelApi 1.1]

コレクション内の位置に基づいてテーブルを取得します。

getItemAt(index: number): Excel.Table;

パラメーター

返品

注釈

[API セット: ExcelApi 1.1]

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

getItemOrNullObject(key: string): Excel.Table;

パラメーター

返品

注釈

[API セット: ExcelApi 1.4]

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

load(options?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection;

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

toJSON(): Excel.Interfaces.TableCollectionData;

返品

ブックに新しいテーブルが追加されたときに発生します。

readonly onAdded: OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.9]

ブック内の任意のテーブルまたはワークシートのデータが変更されたときに発生します。

readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.7]

指定されたテーブルがブックで削除されたときに発生します。

readonly onDeleted: OfficeExtension.EventHandlers<Excel.TableDeletedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.9]