Excel.TableColumnCollection class
表の一部であるすべての列のコレクションを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| count | テーブルの列数を返します。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(index, values, name) | テーブルに新しい列を追加します。 |
| add |
テーブルに新しい列を追加します。 とは異なり |
| get |
表の列数を取得します。 |
| get |
名前または ID によって、列オブジェクトを取得します。 |
| get |
コレクション内の位置に基づいて列を取得します。 |
| get |
名前または ID によって、列オブジェクトを取得します。 列が存在しない場合、このメソッドは プロパティが に設定されたオブジェクトを |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
count
items
メソッドの詳細
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は、既定の名前が使用されます。
戻り値
注釈
例
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
オプション。 新しい列の相対位置を指定します。 null または -1 の場合、最後に追加が行われます。 上位のインデックスを持つ列は横にシフトされます。 0 を起点とする番号になります。
- values
-
Excel.CellValue[][]
オプション。 テーブル列のセル値の 2D 配列。
- name
-
string
オプション。 新しい列の名前を指定します。 の場合 nullは、既定の名前が使用されます。
戻り値
注釈
getCount()
表の列数を取得します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
注釈
getItem(key)
名前または ID によって、列オブジェクトを取得します。
getItem(key: number | string): Excel.TableColumn;パラメーター
- key
-
number | string
列名または ID。
戻り値
注釈
例
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 を起点とする番号になります。
戻り値
注釈
例
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 によって、列オブジェクトを取得します。 列が存在しない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getItemOrNullObject(key: number | string): Excel.TableColumn;パラメーター
- key
-
number | string
列名または ID。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.TableColumnCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
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)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableColumnCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元 Excel.TableColumnCollection のオブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.TableColumnCollectionData型指定) を返します。
toJSON(): Excel.Interfaces.TableColumnCollectionData;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示