Excel.Table class
Excel の表を表します。 テーブル オブジェクト モデルの詳細については、「Excel JavaScript API を使用してテーブルを操作する」を参照してください。
- Extends
注釈
[API セット: ExcelApi 1.1]
プロパティ
| auto |
テーブルの |
| columns | テーブルに含まれるすべての列のコレクションを表します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| highlight |
最初の列に特別な書式が含まれているかどうかを指定します。 |
| highlight |
最後の列に特別な書式が設定されているかどうかを指定します。 |
| id | 指定されたブックのテーブルを一意に識別する値を返します。 識別子の値は、テーブルの名前が変更された場合も変わりません。 |
| legacy |
数値 ID を返します。 |
| name | テーブルの名前。 テーブルのセット名は、「 Excel テーブルの名前を変更する」 の記事で指定されているガイドラインに従う必要があります。 |
| rows | テーブルに含まれるすべての行のコレクションを表します。 |
| show |
テーブルを読みやすくするために、奇数列が偶数列とは異なる方法で強調表示される縞模様の書式設定を列に表示するかどうかを指定します。 |
| show |
表を読みやすくするために、奇数行と偶数行が異なるように強調表示される縞模様の書式設定を行にするかどうかを指定します。 |
| show |
各列ヘッダーの上部にフィルター ボタンを表示するかどうかを指定します。 これは、テーブルにヘッダー行が含まれている場合のみ設定できます。 |
| show |
ヘッダー行を表示するかどうかを指定します。 この値によって、ヘッダー行の表示または削除を設定できます。 |
| show |
合計行を表示するかどうかを指定します。 この値によって、集計行の表示または削除を設定できます。 |
| sort | テーブル内の並べ替えを表します。 |
| style | 表のスタイルを表す定数値。 指定可能な値は、"TableStyleLight1" から "TableStyleLight21"、"TableStyleMedium1" から "TableStyleMedium28"、"TableStyleDark1" から "TableStyleDark11" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。 |
| worksheet | 現在のテーブルを含んでいるワークシート。 |
メソッド
| clear |
現在テーブルに適用されているすべてのフィルターをクリアします。 |
| convert |
テーブルを通常の範囲のセルに変換します。 すべてのデータが保持されます。 |
| delete() | テーブルを削除します。 |
| get |
テーブルのデータ本体に関連付けられた範囲オブジェクトを取得します。 |
| get |
表のヘッダー行に関連付けられた範囲オブジェクトを取得します。 |
| get |
テーブル全体に関連付けられた範囲オブジェクトを取得します。 |
| get |
表の集計行に関連付けられた範囲オブジェクトを取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| reapply |
現在テーブルにあるすべてのフィルターを再適用します。 |
| resize(new |
テーブルのサイズを新しい範囲に変更します。 新しい範囲は元のテーブルの範囲と重なっていて、ヘッダー (またはテーブルの先頭) が同じ行にある必要があります。 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
イベント
| on |
特定のテーブルのセル内のデータが変更されたときに発生します。 |
| on |
特定のテーブルの選択が変更されたときに発生します。 |
プロパティの詳細
autoFilter
テーブルの AutoFilter オブジェクトを表します。
readonly autoFilter: Excel.AutoFilter;
プロパティ値
注釈
[API セット: ExcelApi 1.9]
columns
テーブルに含まれるすべての列のコレクションを表します。
readonly columns: Excel.TableColumnCollection;
プロパティ値
注釈
[API セット: ExcelApi 1.1]
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
highlightFirstColumn
最初の列に特別な書式が含まれているかどうかを指定します。
highlightFirstColumn: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.3]
highlightLastColumn
最後の列に特別な書式が設定されているかどうかを指定します。
highlightLastColumn: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.3]
id
指定されたブックのテーブルを一意に識別する値を返します。 識別子の値は、テーブルの名前が変更された場合も変わりません。
readonly id: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.1]
legacyId
数値 ID を返します。
readonly legacyId: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.8]
name
テーブルの名前。
テーブルのセット名は、「 Excel テーブルの名前を変更する」 の記事で指定されているガイドラインに従う必要があります。
name: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.1]
rows
テーブルに含まれるすべての行のコレクションを表します。
readonly rows: Excel.TableRowCollection;
プロパティ値
注釈
[API セット: ExcelApi 1.1]
showBandedColumns
テーブルを読みやすくするために、奇数列が偶数列とは異なる方法で強調表示される縞模様の書式設定を列に表示するかどうかを指定します。
showBandedColumns: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.3]
showBandedRows
表を読みやすくするために、奇数行と偶数行が異なるように強調表示される縞模様の書式設定を行にするかどうかを指定します。
showBandedRows: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.3]
showFilterButton
各列ヘッダーの上部にフィルター ボタンを表示するかどうかを指定します。 これは、テーブルにヘッダー行が含まれている場合のみ設定できます。
showFilterButton: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.3]
showHeaders
ヘッダー行を表示するかどうかを指定します。 この値によって、ヘッダー行の表示または削除を設定できます。
showHeaders: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.1]
showTotals
合計行を表示するかどうかを指定します。 この値によって、集計行の表示または削除を設定できます。
showTotals: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.1]
sort
style
表のスタイルを表す定数値。 指定可能な値は、"TableStyleLight1" から "TableStyleLight21"、"TableStyleMedium1" から "TableStyleMedium28"、"TableStyleDark1" から "TableStyleDark11" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。
style: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.1]
worksheet
現在のテーブルを含んでいるワークシート。
readonly worksheet: Excel.Worksheet;
プロパティ値
注釈
[API セット: ExcelApi 1.2]
メソッドの詳細
clearFilters()
現在テーブルに適用されているすべてのフィルターをクリアします。
clearFilters(): void;
返品
void
注釈
[API セット: ExcelApi 1.2]
convertToRange()
テーブルを通常の範囲のセルに変換します。 すべてのデータが保持されます。
convertToRange(): Excel.Range;
返品
注釈
[API セット: ExcelApi 1.2]
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.TableLoadOptions): Excel.Table;
パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Table;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Table;
パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
reapplyFilters()
現在テーブルにあるすべてのフィルターを再適用します。
reapplyFilters(): void;
返品
void
注釈
[API セット: ExcelApi 1.2]
resize(newRange)
テーブルのサイズを新しい範囲に変更します。 新しい範囲は元のテーブルの範囲と重なっていて、ヘッダー (またはテーブルの先頭) が同じ行にある必要があります。
resize(newRange: Range | string): void;
パラメーター
- newRange
-
Excel.Range | string
テーブルの新しいサイズを決定するために使用される範囲オブジェクトまたは範囲アドレス。
返品
void
注釈
[API セット: ExcelApi 1.13]
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;
パラメーター
- properties
- Excel.Interfaces.TableUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.Table): void;
パラメーター
- properties
- Excel.Table
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Table オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.TableData と型指定) を返します。
toJSON(): Excel.Interfaces.TableData;
返品
イベントの詳細
onChanged
特定のテーブルのセル内のデータが変更されたときに発生します。
readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;
イベントの種類
注釈
[API セット: ExcelApi 1.7]
onSelectionChanged
特定のテーブルの選択が変更されたときに発生します。
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.TableSelectionChangedEventArgs>;
イベントの種類
注釈
[API セット: ExcelApi 1.7]