Excel.TableRowCollection class

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

表の一部であるすべての行のコレクションを表します。

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

Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

context

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

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

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

メソッド

add(index, values, alwaysInsert)

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

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

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

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

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

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

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

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

count

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

readonly count: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.1 ]

items

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

readonly items: Excel.TableRow[];

プロパティ値

Excel.TableRow[]

メソッドの詳細

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。

戻り値

Excel.TableRow

注釈

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

例

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);
});

getItemAt(index)

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

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

getItemAt(index: number): Excel.TableRow;

パラメーター

index

number

取得するオブジェクトのインデックス値。 0 を起点とする番号になります。

戻り値

Excel.TableRow

注釈

[ API セット: ExcelApi 1.1 ]

例

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;

パラメーター

options

Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

戻り値

Excel.TableRowCollection

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.TableRowCollection

例

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 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.TableRowCollection

toJSON()

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

toJSON(): Excel.Interfaces.TableRowCollectionData;

戻り値

Excel.Interfaces.TableRowCollectionData