Excel.Interfaces.TableColumnCollectionLoadOptions interface

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

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

$all

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

filter

コレクション内の各項目について: 列に適用されたフィルターを取得します。

id

コレクション内の各項目について: テーブル内の列を識別する一意のキーを返します。

index

コレクション内の各項目について: テーブルの columns コレクション内の列のインデックス番号を返します。 0 を起点とする番号になります。

name

コレクション内の各項目の場合: テーブル列の名前を指定します。

values

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

valuesAsJson

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

valuesAsJsonLocal

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

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

filter

コレクション内の各項目について: 列に適用されたフィルターを取得します。

filter?: Excel.Interfaces.FilterLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.2 ]

id

コレクション内の各項目について: テーブル内の列を識別する一意のキーを返します。

id?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

index

コレクション内の各項目について: テーブルの columns コレクション内の列のインデックス番号を返します。 0 を起点とする番号になります。

index?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

name

コレクション内の各項目の場合: テーブル列の名前を指定します。

name?: boolean;

プロパティ値

boolean

注釈

[ API セット: 名前を取得するための ExcelApi 1.1、それを設定するための 1.4。 ]

values

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

values?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

valuesAsJson

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

valuesAsJson?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.16 ]

valuesAsJsonLocal

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

valuesAsJsonLocal?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.16 ]