Excel.TableRowCollection class

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

context: RequestContext;

プロパティ値

テーブルの行数を返します。

readonly count: number;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

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

readonly items: Excel.TableRow[];

プロパティ値

テーブルに 1 つ以上の行を追加します。 戻りオブジェクトは新しく追加された行の先頭になります。

新しい行または列がその前に追加されると調整される範囲または列とは異なり、 TableRow オブジェクトはテーブル行の物理的な場所を表しますが、データは表しません。 つまり、データが並べ替えられる場合、または新しい行が追加された場合、テーブル行は作成対象のインデックスを指し続けます。

add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;

パラメーター

返品

注釈

[API セット: 1 つの行を追加するための ExcelApi 1.1、1.4 では複数の行を追加できます。1.15 では alwaysInsert パラメーターを追加できます。]

テーブルに 1 つ以上の行を追加します。 返されるオブジェクトは、新しく追加された行の一番上の行になります。 add() とは異なり、addAsJson() は、画像やエンティティのデータ型など、任意の種類のセル値を受け取ります。

新しい行または列がその前に追加されると調整される範囲または列とは異なり、 TableRow オブジェクトはテーブル行の物理的な場所を表しますが、データは表しません。 つまり、データが並べ替えられる場合、または新しい行が追加された場合、テーブル行は作成対象のインデックスを指し続けます。

addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean): Excel.TableRow;

パラメーター

返品

注釈

[API セット: ExcelApi 1.16]

表の行数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

返品

注釈

[API セット: ExcelApi 1.4]

コレクション内の位置を基に行を取得します。

新しい行または列がその前に追加されると調整される範囲または列とは異なり、 TableRow オブジェクトはテーブル行の物理的な場所を表しますが、データは表しません。 つまり、データが並べ替えられる場合、または新しい行が追加された場合、テーブル行は作成対象のインデックスを指し続けます。

getItemAt(index: number): Excel.TableRow;

パラメーター

返品

注釈

[API セット: ExcelApi 1.1]

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

load(options?: Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection;

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

toJSON(): Excel.Interfaces.TableRowCollectionData;

返品