Excel.TableColumn class
テーブル内にある 1 つの列を表します。
- Extends
注釈
[API セット: ExcelApi 1.1]
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| filter | 列に適用されているフィルターを取得します。 |
| id | テーブル内の列を識別する一意のキーを返します。 |
| index | テーブルの列コレクション内の列のインデックス番号を返します。 0 を起点とする番号になります。 |
| name | テーブルの列の名前を指定します。 |
| values | 指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。 |
| values |
このテーブル列のセルの値の JSON 表現。
|
| values |
このテーブル列のセルの値の JSON 表現。
|
メソッド
| delete() | テーブルから列を削除します。 |
| get |
列のデータ本体に関連付けられた範囲オブジェクトを取得します。 |
| get |
列のヘッダー行に関連付けられた範囲オブジェクトを取得します。 |
| get |
列全体に関連付けられた範囲オブジェクトを取得します。 |
| get |
列の集計行に関連付けられた範囲オブジェクトを取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
filter
id
テーブル内の列を識別する一意のキーを返します。
readonly id: number;プロパティ値
number
注釈
[API セット: ExcelApi 1.1]
index
テーブルの列コレクション内の列のインデックス番号を返します。 0 を起点とする番号になります。
readonly index: number;プロパティ値
number
注釈
[API セット: ExcelApi 1.1]
name
テーブルの列の名前を指定します。
name: string;プロパティ値
string
注釈
[API セット: 名前を取得するための ExcelApi 1.1、設定するための 1.4。]
values
指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。
values: any[][];プロパティ値
any[][]
注釈
[API セット: ExcelApi 1.1]
valuesAsJson
このテーブル列のセルの値の JSON 表現。
TableColumn.values
とは異なり、TableColumn.valuesAsJson はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常に en-US ロケールに合わせて調整されます。 ユーザーの表示ロケールでデータを取得するには、 TableColumn.valuesAsJsonLocal を使用します。
valuesAsJson: CellValue[][];プロパティ値
Excel.CellValue[][]
注釈
[API セット: ExcelApi 1.16]
valuesAsJsonLocal
このテーブル列のセルの値の JSON 表現。
TableColumn.values
とは異なり、TableColumn.valuesAsJsonLocal はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常にユーザーの表示ロケールに合わせて調整されます。 ロケールに関係なくデータを取得するには、 TableColumn.valuesAsJson を使用します。
valuesAsJsonLocal: CellValue[][];プロパティ値
Excel.CellValue[][]
注釈
[API セット: ExcelApi 1.16]
メソッドの詳細
delete()
テーブルから列を削除します。
delete(): void;返品
void
注釈
[API セット: ExcelApi 1.1]
getDataBodyRange()
列のデータ本体に関連付けられた範囲オブジェクトを取得します。
getDataBodyRange(): Excel.Range;返品
注釈
[API セット: ExcelApi 1.1]
getHeaderRowRange()
列のヘッダー行に関連付けられた範囲オブジェクトを取得します。
getHeaderRowRange(): Excel.Range;返品
注釈
[API セット: ExcelApi 1.1]
getRange()
getTotalRowRange()
列の集計行に関連付けられた範囲オブジェクトを取得します。
getTotalRowRange(): Excel.Range;返品
注釈
[API セット: ExcelApi 1.1]
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.TableColumnLoadOptions): Excel.TableColumn;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.TableColumn;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.TableColumn;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.TableColumnUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.TableColumn): void;パラメーター
- properties
- Excel.TableColumn
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.TableColumn オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.TableColumnData と型指定) を返します。
toJSON(): Excel.Interfaces.TableColumnData;