Excel.TableRow class
テーブル内の行を表します。
範囲または列とは異なり、新しい行または列の前に追加された場合に調整されます。 TableRow オブジェクトはテーブル行の物理的な場所を表しますが、データは表しません。 つまり、データが並べ替えられた場合、または新しい行が追加された場合、テーブル行は作成されたインデックスを指し続けます。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| index | テーブルの行コレクション内の行のインデックス番号を返します。 0 を起点とする番号になります。 |
| values | 指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値のいずれかです。 エラーが含まれているセルは、エラー文字列を返します。 返される値が正符号 ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。 |
| values |
このテーブル行のセル内の値の JSON 表現。
|
| values |
このテーブル行のセル内の値の JSON 表現。
|
メソッド
| delete() | テーブルから行を削除します。 |
| get |
行全体に関連付けられた範囲オブジェクトを返します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
index
テーブルの行コレクション内の行のインデックス番号を返します。 0 を起点とする番号になります。
readonly index: number;プロパティ値
number
注釈
values
指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値のいずれかです。 エラーが含まれているセルは、エラー文字列を返します。 返される値が正符号 ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。
values: any[][];プロパティ値
any[][]
注釈
valuesAsJson
このテーブル行のセル内の値の JSON 表現。
TableRow.values
とは異なり、TableRow.valuesAsJsonではセルに含めることができるすべてのデータ型がサポートされます。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常に en-US ロケールと一致します。 ユーザーの表示ロケールでデータを取得するには、 TableRow.valuesAsJsonLocalを使用します。
valuesAsJson: CellValue[][];プロパティ値
Excel.CellValue[][]
注釈
valuesAsJsonLocal
このテーブル行のセル内の値の JSON 表現。
TableRow.values
とは異なり、TableRow.valuesAsJsonLocalではセルに含めることができるすべてのデータ型がサポートされます。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常にユーザーの表示ロケールと一致します。 ロケールに依存しないデータを取得するには、 TableRow.valuesAsJsonを使用します。
valuesAsJsonLocal: CellValue[][];プロパティ値
Excel.CellValue[][]
注釈
メソッドの詳細
delete()
テーブルから行を削除します。
delete(): void;戻り値
void
注釈
例
await Excel.run(async (context) => {
const tableName = 'Table1';
const row = context.workbook.tables.getItem(tableName).rows.getItemAt(2);
row.delete();
await context.sync();
});
getRange()
行全体に関連付けられた範囲オブジェクトを返します。
getRange(): Excel.Range;戻り値
注釈
例
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);
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.TableRowLoadOptions): Excel.TableRow;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.TableRow;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
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);
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.TableRow;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.TableRowUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.TableRow): void;パラメーター
- properties
- Excel.TableRow
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.TableRow オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.TableRowData として型指定) を返します。
toJSON(): Excel.Interfaces.TableRowData;戻り値
Office Add-ins