Excel.TableRow class

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

context: RequestContext;

プロパティ値

テーブルの行コレクション内の行のインデックス番号を返します。 0 を起点とする番号になります。

readonly index: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値のいずれかです。 エラーが含まれているセルは、エラー文字列を返します。 返される値が正符号 ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。

values: any[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

このテーブル行のセル内の値の JSON 表現。 TableRow.values とは異なり、TableRow.valuesAsJsonではセルに含めることができるすべてのデータ型がサポートされます。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常に en-US ロケールと一致します。 ユーザーの表示ロケールでデータを取得するには、 TableRow.valuesAsJsonLocalを使用します。

valuesAsJson: CellValue[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.16 ]

このテーブル行のセル内の値の JSON 表現。 TableRow.values とは異なり、TableRow.valuesAsJsonLocalではセルに含めることができるすべてのデータ型がサポートされます。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常にユーザーの表示ロケールと一致します。 ロケールに依存しないデータを取得するには、 TableRow.valuesAsJsonを使用します。

valuesAsJsonLocal: CellValue[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.16 ]

テーブルから行を削除します。

delete(): void;

戻り値

注釈

[ API セット: ExcelApi 1.1 ]

例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(2);
    row.delete();
    await context.sync(); 
});

行全体に関連付けられた範囲オブジェクトを返します。

getRange(): Excel.Range;

戻り値

注釈

[ API セット: ExcelApi 1.1 ]

例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
    const rowRange = row.getRange();
    rowRange.load('address');
    await context.sync();
    
    console.log(rowRange.address);
});

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

load(options?: Excel.Interfaces.TableRowLoadOptions): Excel.TableRow;

パラメーター

戻り値

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

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

パラメーター

戻り値

例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
    row.load('index');
    await context.sync();
    
    console.log(row.index);
});

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TableRow;

パラメーター

戻り値

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

戻り値

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.TableRow): void;

パラメーター

戻り値

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

toJSON(): Excel.Interfaces.TableRowData;

戻り値