Excel.Interfaces.TableRowCollectionLoadOptions interface

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

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

プロパティ

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

index

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

values

For each ITEM in the collection: 指定した範囲の未処理の値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。

valuesAsJson

コレクション内の各アイテムの場合: このテーブル行のセルの値の JSON 表現。 TableRow.values とは異なり、TableRow.valuesAsJson はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常に en-US ロケールに合わせて調整されます。 ユーザーの表示ロケールでデータを取得するには、 TableRow.valuesAsJsonLocal を使用します。

valuesAsJsonLocal

コレクション内の各アイテムの場合: このテーブル行のセルの値の JSON 表現。 TableRow.values とは異なり、TableRow.valuesAsJsonLocal はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常にユーザーの表示ロケールに合わせて調整されます。 ロケールに関係なくデータを取得するには、 TableRow.valuesAsJson を使用します。

プロパティの詳細

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

index

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

index?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

values

For each ITEM in the collection: 指定した範囲の未処理の値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。

values?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

valuesAsJson

コレクション内の各アイテムの場合: このテーブル行のセルの値の JSON 表現。 TableRow.values とは異なり、TableRow.valuesAsJson はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常に en-US ロケールに合わせて調整されます。 ユーザーの表示ロケールでデータを取得するには、 TableRow.valuesAsJsonLocal を使用します。

valuesAsJson?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.16

valuesAsJsonLocal

コレクション内の各アイテムの場合: このテーブル行のセルの値の JSON 表現。 TableRow.values とは異なり、TableRow.valuesAsJsonLocal はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常にユーザーの表示ロケールに合わせて調整されます。 ロケールに関係なくデータを取得するには、 TableRow.valuesAsJson を使用します。

valuesAsJsonLocal?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.16