Excel.TableCollection class
ブックまたはワークシートの一部として含まれる、すべてのテーブルのコレクションを、到達方法に応じて表します。
- Extends
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml
// Add checkboxes to the table.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Get the second column in the table, without the header.
const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();
// Change the boolean values to checkboxes.
range.control = {
type: Excel.CellControlType.checkbox
};
await context.sync();
});
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| count | ブックに含まれるテーブルの数を返します。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(address, has |
新しいテーブルを作成します。 範囲オブジェクトまたはソース アドレスにより、テーブルが追加されるワークシートが判断されます。 テーブルが追加できない場合 (たとえば、アドレスが無効な場合や、テーブルが別のテーブルと重複している場合) は、エラーがスローされます。 |
| get |
コレクションに含まれるテーブルの数を取得します。 |
| get |
名前または ID でテーブルを取得します。 |
| get |
コレクション内の位置に基づいてテーブルを取得します。 |
| get |
名前または ID でテーブルを取得します。 テーブルが存在しない場合、このメソッドは |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
イベント
| on |
ブックに新しいテーブルが追加されたときに発生します。 |
| on |
ブックまたはワークシート内の任意のテーブルでデータが変更されたときに発生します。 |
| on |
指定されたテーブルがブックで削除されたときに発生します。 |
| on |
ブックまたはワークシート内の任意のテーブルにフィルターを適用すると発生します。 |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
count
items
メソッドの詳細
add(address, hasHeaders)
新しいテーブルを作成します。 範囲オブジェクトまたはソース アドレスにより、テーブルが追加されるワークシートが判断されます。 テーブルが追加できない場合 (たとえば、アドレスが無効な場合や、テーブルが別のテーブルと重複している場合) は、エラーがスローされます。
add(address: Range | string, hasHeaders: boolean): Excel.Table;パラメーター
- address
-
Excel.Range | string
Range オブジェクト、またはデータ ソースを表す文字列アドレスまたは範囲の名前。 アドレスにシート名が含まれていない場合は、現在作業中のシートが使用されます。 [Api set: ExcelApi 1.1/ 1.3。 ExcelApi 1.3 より前のパラメーターは文字列である必要があります。 Excel Api 1.3 以降では、このパラメーターには Range オブジェクトまたは文字列を指定できます。
- hasHeaders
-
boolean
インポートされるデータに列ラベルがあるかどうかを示すブール値。 ソースにヘッダーが含まれていない場合 (つまり、このプロパティが false に設定されている場合)、Excel はヘッダーを自動的に生成し、データを 1 行ずつシフトします。
戻り値
注釈
例
await Excel.run(async (context) => {
const table = context.workbook.tables.add('Sheet1!A1:E7', true);
table.load('name');
await context.sync();
console.log(table.name);
});
getCount()
コレクションに含まれるテーブルの数を取得します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
注釈
getItem(key)
名前または ID でテーブルを取得します。
getItem(key: string): Excel.Table;パラメーター
- key
-
string
取得するテーブルの名前または ID。
戻り値
注釈
例
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.load('name');
await context.sync();
console.log(table.name);
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml
// Remove checkboxes from the table.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Get the second column in the table, without the header.
const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();
// Change the checkboxes back to boolean values.
range.control = {
type: Excel.CellControlType.empty
};
await context.sync();
});
getItemAt(index)
コレクション内の位置に基づいてテーブルを取得します。
getItemAt(index: number): Excel.Table;パラメーター
- index
-
number
取得するオブジェクトのインデックス値。 0 を起点とする番号になります。
戻り値
注釈
例
await Excel.run(async (context) => {
const table = context.workbook.tables.getItemAt(0);
table.load('name');
await context.sync();
console.log(table.name);
});
getItemOrNullObject(key)
名前または ID でテーブルを取得します。 テーブルが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getItemOrNullObject(key: string): Excel.Table;パラメーター
- key
-
string
取得するテーブルの名前または ID。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.TableCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
// Get the number of tables.
await Excel.run(async (context) => {
const tables = context.workbook.tables;
tables.load('count');
await context.sync();
console.log(tables.count);
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.TableCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.TableCollectionDataとして型指定) を返します。
toJSON(): Excel.Interfaces.TableCollectionData;戻り値
イベントの詳細
onAdded
ブックに新しいテーブルが追加されたときに発生します。
readonly onAdded: OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>;イベントの種類
注釈
onChanged
ブックまたはワークシート内の任意のテーブルでデータが変更されたときに発生します。
readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;イベントの種類
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml
await Excel.run(async (context) => {
let tables = context.workbook.tables;
tables.onChanged.add(onChange);
await context.sync();
console.log("A handler has been registered for the table collection onChanged event");
});
onDeleted
指定されたテーブルがブックで削除されたときに発生します。
readonly onDeleted: OfficeExtension.EventHandlers<Excel.TableDeletedEventArgs>;イベントの種類
注釈
onFiltered
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ブックまたはワークシート内の任意のテーブルにフィルターを適用すると発生します。
readonly onFiltered: OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>;