Excel.TableRowCollection class
表の一部であるすべての行のコレクションを表します。
範囲または列とは異なり、新しい行または列の前に追加された場合に調整されます。 TableRow オブジェクトはテーブル行の物理的な場所を表しますが、データは表しません。 つまり、データが並べ替えられた場合、または新しい行が追加された場合、テーブル行は作成されたインデックスを指し続けます。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| count | テーブルの行数を返します。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(index, values, always |
テーブルに 1 つ以上の行を追加します。 戻りオブジェクトは新しく追加された行の先頭になります。 範囲または列とは異なり、新しい行または列の前に追加された場合に調整されます。 |
| add |
テーブルに 1 つ以上の行を追加します。 返されるオブジェクトは、新しく追加された行または行の先頭行になります。
範囲または列とは異なり、新しい行または列の前に追加された場合に調整されます。 |
| delete |
テーブルから複数の行を削除します。 これらの行はシーケンシャルである必要はありません。 選択した行が既に削除されているか、存在しない場合、このメソッドは |
| delete |
指定したインデックスから始まる、指定した数の行をテーブルから削除します。 メソッドが呼び出されたテーブルにフィルターが適用されている場合、このメソッドは |
| get |
表の行数を取得します。 |
| get |
コレクション内の位置を基に行を取得します。 範囲または列とは異なり、新しい行または列の前に追加された場合に調整されます。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
count
items
メソッドの詳細
add(index, values, alwaysInsert)
テーブルに 1 つ以上の行を追加します。 戻りオブジェクトは新しく追加された行の先頭になります。
範囲または列とは異なり、新しい行または列の前に追加された場合に調整されます。 TableRow オブジェクトはテーブル行の物理的な場所を表しますが、データは表しません。 つまり、データが並べ替えられた場合、または新しい行が追加された場合、テーブル行は作成されたインデックスを指し続けます。
add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;パラメーター
- index
-
number
省略可能。 新しい行の相対位置を指定します。 null または -1 の場合、最後に追加が行われます。 挿入した行の下のすべての行が下方向にシフトします。 0 を起点とする番号になります。
- values
-
Array<Array<boolean | string | number>> | boolean | string | number
省略可能。 テーブル行の書式設定されていない値の 2D 配列。
- alwaysInsert
-
boolean
省略可能。 新しい行を追加するときに、新しい行をテーブルに挿入するかどうかを指定します。
true
場合、新しい行がテーブルに挿入されます。
false
場合、新しい行がテーブルの下に追加されます。 既定値は trueです。
戻り値
注釈
[ API セット: 1 つの行を追加するための ExcelApi 1.1。1.4 では複数の行を追加できます。1.15 ではパラメーターalwaysInsert追加できます。
例
await Excel.run(async (context) => {
const tables = context.workbook.tables;
const values = [["Sample", "Values", "For", "New", "Row"]];
const row = tables.getItem("Table1").rows.add(null, values);
row.load('index');
await context.sync();
console.log(row.index);
});
addAsJson(index, values, alwaysInsert)
テーブルに 1 つ以上の行を追加します。 返されるオブジェクトは、新しく追加された行または行の先頭行になります。
add()
とは異なり、addAsJson()はイメージやエンティティのデータ型など、任意の種類のセル値を受け取ります。
範囲または列とは異なり、新しい行または列の前に追加された場合に調整されます。 TableRow オブジェクトはテーブル行の物理的な場所を表しますが、データは表しません。 つまり、データが並べ替えられた場合、または新しい行が追加された場合、テーブル行は作成されたインデックスを指し続けます。
addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean): Excel.TableRow;パラメーター
- index
-
number
省略可能。 新しい行の相対位置を指定します。 null または -1 の場合、最後に追加が行われます。 挿入した行の下のすべての行が下方向にシフトします。 0 を起点とする番号になります。
- values
-
Excel.CellValue[][]
省略可能。 テーブル行のセル値の 2D 配列。
- alwaysInsert
-
boolean
省略可能。 新しい行を追加するときに、新しい行をテーブルに挿入するかどうかを指定します。
true
場合、新しい行がテーブルに挿入されます。
false
場合、新しい行がテーブルの下に追加されます。 既定値は trueです。
戻り値
注釈
deleteRows(rows)
テーブルから複数の行を削除します。 これらの行はシーケンシャルである必要はありません。 選択した行が既に削除されているか、存在しない場合、このメソッドは InvalidArgument エラーをスローします。 メソッドが呼び出されたテーブルにフィルターが適用されている場合、このメソッドは InsertDeleteConflict エラーをスローします。
deleteRows(rows: number[] | TableRow[]): void;パラメーター
- rows
-
number[] | Excel.TableRow[]
テーブルから削除する行インデックス番号または行オブジェクトの配列。
戻り値
void
注釈
deleteRowsAt(index, count)
指定したインデックスから始まる、指定した数の行をテーブルから削除します。 メソッドが呼び出されたテーブルにフィルターが適用されている場合、このメソッドは InsertDeleteConflict エラーをスローします。
deleteRowsAt(index: number, count?: number): void;パラメーター
- index
-
number
削除する行のインデックス値。 注: 行インデックスは、削除操作のたびに、テーブル内の前の行が削除されるたびに更新されます。 削除する行のインデックスが、値を決定してから操作を実行した時刻の間に変更されないようにします。
- count
-
number
削除する行数。 既定では、1 つの行が削除されます。
戻り値
void
注釈
getCount()
表の行数を取得します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
注釈
getItemAt(index)
コレクション内の位置を基に行を取得します。
範囲または列とは異なり、新しい行または列の前に追加された場合に調整されます。 TableRow オブジェクトはテーブル行の物理的な場所を表しますが、データは表しません。 つまり、データが並べ替えられた場合、または新しい行が追加された場合、テーブル行は作成されたインデックスを指し続けます。
getItemAt(index: number): Excel.TableRow;パラメーター
- index
-
number
取得するオブジェクトのインデックス値。 0 を起点とする番号になります。
戻り値
注釈
例
await Excel.run(async (context) => {
const tablerow = context.workbook.tables.getItem('Table1').rows.getItemAt(0);
tablerow.load('values');
await context.sync();
console.log(tablerow.values);
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.TableRowCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
await Excel.run(async (context) => {
const tablerows = context.workbook.tables.getItem('Table1').rows;
tablerows.load('items');
await context.sync();
console.log("tablerows Count: " + tablerows.count);
for (let i = 0; i < tablerows.items.length; i++) {
console.log(tablerows.items[i].index);
}
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableRowCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.TableRowCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.TableRowCollectionDataとして型指定) を返します。
toJSON(): Excel.Interfaces.TableRowCollectionData;戻り値
Office Add-ins