Excel.Table class
Excel の表を表します。 テーブル オブジェクト モデルの詳細については、「 Excel JavaScript API を使用したテーブルの操作」を参照してください。
- Extends
注釈
プロパティ
| columns | テーブルに含まれるすべての列のコレクションを表します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| id | 指定されたブックのテーブルを一意に識別する値を返します。 識別子の値は、テーブルの名前が変更された場合も変わりません。 |
| name | テーブルの名前。 テーブルのセット名は、「Excel テーブルの名前変更」の記事で指定されているガイドライン に 従う必要があります。 |
| rows | テーブルに含まれるすべての行のコレクションを表します。 |
| show |
ヘッダー行を表示するかどうかを指定します。 この値によって、ヘッダー行の表示または削除を設定できます。 |
| show |
合計行を表示するかどうかを指定します。 この値によって、集計行の表示または削除を設定できます。 |
| style | テーブル スタイルを表す定数値。 使用できる値は、"TableStyleLight1" から "TableStyleLight21"、"TableStyleMedium1" から "TableStyleMedium28"、"TableStyleDark1" から "TableStyleDark11" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。 |
メソッド
| delete() | テーブルを削除します。 |
| get |
テーブルのデータ本体に関連付けられた範囲オブジェクトを取得します。 |
| get |
表のヘッダー行に関連付けられた範囲オブジェクトを取得します。 |
| get |
テーブル全体に関連付けられた範囲オブジェクトを取得します。 |
| get |
表の集計行に関連付けられた範囲オブジェクトを取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
columns
テーブルに含まれるすべての列のコレクションを表します。
readonly columns: Excel.TableColumnCollection;プロパティ値
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
id
指定されたブックのテーブルを一意に識別する値を返します。 識別子の値は、テーブルの名前が変更された場合も変わりません。
readonly id: string;プロパティ値
string
注釈
name
rows
テーブルに含まれるすべての行のコレクションを表します。
readonly rows: Excel.TableRowCollection;プロパティ値
注釈
showHeaders
ヘッダー行を表示するかどうかを指定します。 この値によって、ヘッダー行の表示または削除を設定できます。
showHeaders: boolean;プロパティ値
boolean
注釈
showTotals
合計行を表示するかどうかを指定します。 この値によって、集計行の表示または削除を設定できます。
showTotals: boolean;プロパティ値
boolean
注釈
style
テーブル スタイルを表す定数値。 使用できる値は、"TableStyleLight1" から "TableStyleLight21"、"TableStyleMedium1" から "TableStyleMedium28"、"TableStyleDark1" から "TableStyleDark11" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。
style: string;プロパティ値
string
注釈
例
// Set table style.
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.name = 'Table1-Renamed';
table.showTotals = false;
table.style = 'TableStyleMedium2';
table.load('tableStyle');
await context.sync();
console.log(table.style);
});
メソッドの詳細
delete()
テーブルを削除します。
delete(): void;戻り値
void
注釈
例
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.delete();
await context.sync();
});
getDataBodyRange()
テーブルのデータ本体に関連付けられた範囲オブジェクトを取得します。
getDataBodyRange(): Excel.Range;戻り値
注釈
例
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableDataRange = table.getDataBodyRange();
tableDataRange.load('address')
await context.sync();
console.log(tableDataRange.address);
});
getHeaderRowRange()
表のヘッダー行に関連付けられた範囲オブジェクトを取得します。
getHeaderRowRange(): Excel.Range;戻り値
注釈
例
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableHeaderRange = table.getHeaderRowRange();
tableHeaderRange.load('address');
await context.sync();
console.log(tableHeaderRange.address);
});
getRange()
テーブル全体に関連付けられた範囲オブジェクトを取得します。
getRange(): Excel.Range;戻り値
注釈
例
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableRange = table.getRange();
tableRange.load('address');
await context.sync();
console.log(tableRange.address);
});
getTotalRowRange()
表の集計行に関連付けられた範囲オブジェクトを取得します。
getTotalRowRange(): Excel.Range;戻り値
注釈
例
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableTotalsRange = table.getTotalRowRange();
tableTotalsRange.load('address');
await context.sync();
console.log(tableTotalsRange.address);
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.TableLoadOptions): Excel.Table;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Table;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
// Get a table by name.
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.load('id')
await context.sync();
console.log(table.id);
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Table;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.TableUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.Table): void;パラメーター
- properties
- Excel.Table
戻り値
void
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.Table オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.TableData型指定) を返します。
toJSON(): Excel.Interfaces.TableData;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示