Excel.TableColumnCollection class

リファレンス

パッケージ:: excel

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

Extends: OfficeExtension.ClientObject

注釈

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
count	テーブルの列数を返します。
items	このコレクション内に読み込まれた子アイテムを取得します。

メソッド

add(index, values, name)	テーブルに新しい列を追加します。
addAsJson(index, values, name)	テーブルに新しい列を追加します。 `add()` とは異なり、`addAsJson()`はイメージやエンティティのデータ型など、任意の種類のセル値を受け取ります。
getCount()	表の列数を取得します。
getItem(key)	名前または ID によって、列オブジェクトを取得します。
getItemAt(index)	コレクション内の位置に基づいて列を取得します。
getItemOrNullObject(key)	名前または ID によって、列オブジェクトを取得します。列が存在しない場合、このメソッドは `isNullObject` プロパティを `true` に設定したオブジェクトを返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
toJSON()	API オブジェクトが`JSON.stringify()`に渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (`JSON.stringify`、それに渡されるオブジェクトの `toJSON` メソッドを呼び出します)。元の `Excel.TableColumnCollection` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( `Excel.Interfaces.TableColumnCollectionData`として型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

count

テーブルの列数を返します。

readonly count: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.1 ]

items

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Excel.TableColumn[];

プロパティ値

Excel.TableColumn[]

メソッドの詳細

add(index, values, name)

テーブルに新しい列を追加します。

add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string): Excel.TableColumn;

パラメーター

index: number

省略可能。新しい列の相対位置を指定します。 null または -1 の場合、最後に追加が行われます。上位のインデックスを持つ列は横にシフトされます。 0 を起点とする番号になります。

values: Array<Array<boolean | string | number>> | boolean | string | number

省略可能。テーブル列の書式設定されていない値の 2D 配列。

name: string

省略可能。新しい列の名前を指定します。 null 場合は、既定の名前が使用されます。

戻り値

Excel.TableColumn

注釈

[ API セット: ExcelApi 1.1 には、合計列数より小さいインデックスが必要です。1.4 では、インデックスを省略可能 (null または -1) にし、最後に列を追加します。1.4 では作成時に name パラメーターを使用できます。 ]

例

await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    const values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]];
    const column = tables.getItem("Table1").columns.add(null, values);
    column.load('name');
    await context.sync();
    
    console.log(column.name);
});

addAsJson(index, values, name)

テーブルに新しい列を追加します。 add() とは異なり、addAsJson()はイメージやエンティティのデータ型など、任意の種類のセル値を受け取ります。

addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.TableColumn;

パラメーター

index: number

values: Excel.CellValue[][]

省略可能。テーブル列のセル値の 2D 配列。

name: string

省略可能。新しい列の名前を指定します。 null 場合は、既定の名前が使用されます。

戻り値

Excel.TableColumn

注釈

[ API セット: ExcelApi 1.16 ]

getCount()

表の列数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API セット: ExcelApi 1.4 ]

getItem(key)

名前または ID によって、列オブジェクトを取得します。

getItem(key: number | string): Excel.TableColumn;

パラメーター

key: number | string

列名または ID。

戻り値

Excel.TableColumn

注釈

[ API セット: ExcelApi 1.1 ]

例

await Excel.run(async (context) => { 
    const tableColumn = context.workbook.tables.getItem('Table1').columns.getItem(0);
    tableColumn.load('name');
    await context.sync();
    console.log(tableColumn.name);
});

getItemAt(index)

コレクション内の位置に基づいて列を取得します。

getItemAt(index: number): Excel.TableColumn;

パラメーター

index: number

取得するオブジェクトのインデックス値。 0 を起点とする番号になります。

戻り値

Excel.TableColumn

注釈

[ API セット: ExcelApi 1.1 ]

例

await Excel.run(async (context) => { 
    const tableColumn = context.workbook.tables.getItem['Table1'].columns.getItemAt(0);
    tableColumn.load('name');
    await context.sync();
    console.log(tableColumn.name);
});

getItemOrNullObject(key)

名前または ID によって、列オブジェクトを取得します。列が存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getItemOrNullObject(key: number | string): Excel.TableColumn;

パラメーター

key: number | string

列名または ID。

戻り値

Excel.TableColumn

注釈

[ API セット: ExcelApi 1.4 ]

load(options)

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

load(options?: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection;

パラメーター

options: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.TableColumnCollection

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.TableColumnCollection

例

await Excel.run(async (context) => { 
    const tableColumns = context.workbook.tables.getItem('Table1').columns;
    tableColumns.load('items');
    await context.sync();
    
    console.log("tableColumns Count: " + tableColumns.count);
    for (let i = 0; i < tableColumns.items.length; i++) {
        console.log(tableColumns.items[i].name);
    }
});

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableColumnCollection;

パラメーター

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.TableColumnCollection

toJSON()

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

toJSON(): Excel.Interfaces.TableColumnCollectionData;

戻り値

Excel.Interfaces.TableColumnCollectionData

次の方法で共有

Excel.TableColumnCollection class

注釈

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

count

プロパティ値

注釈

items

プロパティ値

メソッドの詳細

add(index, values, name)

パラメーター

戻り値

注釈

例

addAsJson(index, values, name)

パラメーター

戻り値

注釈

getCount()

戻り値

注釈

getItem(key)

パラメーター

戻り値

注釈

例

getItemAt(index)

パラメーター

戻り値

注釈

例

getItemOrNullObject(key)

パラメーター

戻り値

注釈

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

例

load(propertyNamesAndPaths)

パラメーター

戻り値

toJSON()

戻り値

その他のリソース