Ignite UI™ API ヘルプ

ig.excel.WorksheetTable

テーブルとして書式設定されたセルの領域を表します。

備考

テーブルは、一定範囲の関連データを管理/分析する際に役立ちます。テーブル内のデータの管理は、ワークシート内にある他のデータとは別個に行えます。

テーブルには 1 つ以上の列が含まれ、並べ替えや絞り込みが行えるようになっています。列に適用できる並べ替え条件や絞り込み条件にはさまざまなタイプがあります。絞り込みに関するタイプは Infragistics.Documents.Excel.Filtering 名前空間で調べることができ、フィルターは、WorksheetTableColumn.filter プロパティを設定することによって列に適用できるようになります。並べ替えに関するタイプは Infragistics.Documents.Excel.Sorting 名前空間で調べることができ、列の並べ替えは、WorksheetTableColumn.sortCondition を設定することによって、もしくは WorksheetTable.sortSettings に関する SortSettings`1.sortConditions コレクションを作成することによって実現できます。

テーブルには、計算式に基づいて列値を動的に決定する集計列を含めることができます。WorksheetTableColumn は、WorksheetTableColumn.columnFormula の設定によって集計列にすることができます。

テーブルには、そのテーブルに関する集計情報を表示する集計行を含めることもできます。これは、 WorksheetTable.isTotalsRowVisible を True に設定することで表示できます。集計行の各列には、WorksheetTableColumn.totalLabel と WorksheetTableColumn.totalFormula のいずれかを設定することにより、それぞれテキストまたは集計値を表示できるようになります。

依存関係

jquery-1.4.4.js

infragistics.util.js

infragistics.ext_core.js

infragistics.ext_collections.js

infragistics.ext_collectionsExtended.js

infragistics.ext_io.js

infragistics.ext_text.js

infragistics.documents.core_core.js

infragistics.ext_ui.js

詳細の表示

areaFormats

.areaFormats( );

返却型:

ig.excel.WorksheetTableAreaFormatsCollection`1

返却型の説明:

指定した領域の外観を説明する IWorksheetCellFormat インスタンス。
WorksheetTable の各領域で使用される書式のコレクションを取得します。
備考
書式設定の対象として選択できるテーブル領域は、テーブル全体、ヘッダー、データ、および集計領域です。

ある領域に書式を適用すると、その領域内のすべてのセルに同じ書式が適用されます。

テーブルのサイズを変更して列の数を増やすときに特定のテーブル領域に関する書式を設定した場合、新しい列の領域書式設定がテーブルの領域書式設定と初期化されます。
関連項目

areaFormats

.areaFormats( area:ig.excel.WorksheetTableArea );
返却型:: ig.excel.IWorksheetCellFormat
返却型の説明:: 指定した領域の外観を説明する IWorksheetCellFormat インスタンス。

WorksheetTable の各領域で使用される書式のコレクションを取得します。

area
タイプ:ig.excel.WorksheetTableArea
書式を取得したい領域。

例外

例外	説明
ig.excel.InvalidEnumArgumentException	領域は定義されていません。

columns

.columns( index:number );
返却型:: ig.excel.WorksheetTableColumn
返却型の説明:: 指定されたインデックスにある WorksheetTableColumn 。

このテーブル内にある列のコレクションを取得します。

index
タイプ:number
取得する列のインデックス (ゼロを基準とした数値)。

例外

例外	説明
ig.ArgumentOutOfRangeException	インデックスが、ゼロ未満、またはコレクションに含まれる列数以上の値です。

comment
継承

.comment( );
返却型:: string
返却型の説明:

例外

例外	説明
ig.ArgumentException

comment
継承

.comment( value:string );
返却型:: string
返却型の説明:

value
タイプ:string

例外

例外	説明
ig.ArgumentException

dataAreaRegion

.dataAreaRegion( );

返却型:

ig.excel.WorksheetRegion

返却型の説明:
テーブルのデータ領域内にあるセル領域を表す WorksheetRegion を取得します。
備考
テーブルのデータ領域を Resize オーバーロードを使用して変更できます。
関連項目

deleteColumns

.deleteColumns( tableColumnIndex:number, [count:number] );

1 列以上を表から削除します。

tableColumnIndex
タイプ:number
削除は、表の最初の列から適用されます。
count
タイプ:number
オプション
削除する列の数。

例外

例外	説明
ig.InvalidOperationException	操作が許可されていない場合、例えばワークシートからデータが移動される恐れがある場合。
ig.IndexOutOfRangeException	インデックスが負の数の場合。
ig.ArgumentOutOfRangeException	カウントが 1 より小さい、または表に含まれる列数以上の値の場合。

deleteDataRows

.deleteDataRows( dataRowIndex:number, [count:number] );

表から 1 つ以上の行を削除します。

dataRowIndex
タイプ:number
削除は、WorksheetTable.dataAreaRegion の最初の行から適用されます。
count
タイプ:number
オプション
削除する行の数。

例外

例外	説明
ig.InvalidOperationException	操作が許可されていない場合、例えばワークシートからデータが移動される恐れがある場合。
ig.IndexOutOfRangeException	インデックスが負の数の場合。
ig.ArgumentOutOfRangeException	カウントが 1 より小さい、または表に含まれる行数 (ヘッダーおよび合計行以外) 以上の値の場合。

displayBandedColumns

.displayBandedColumns( );
隔列書式を WorksheetTable の該当列に適用するどうかを示す値を取得または設定します。
備考
列の書式は、WorksheetTable に適用される WorksheetTableStyle によって決まります。こうした書式は、WorksheetTableStyle.areaFormats コレクションに収められ、.ColumnStripe 値および WorksheetTableStyleArea.ColumnStripe 値の参照キーが付けられます。AlternateColumnStripe 値に領域の書式が適用されていない場合、このプロパティはテーブルの表示に影響を与えません。

この値が True であり、かつ、隔列ストライプに関する領域書式がない場合、ストライプの幅は WorksheetTableStyle.columnStripeWidth と WorksheetTableStyle.alternateColumnStripeWidth の値によって定義されます。
関連項目
displayBandedColumns

.displayBandedColumns( value:boolean );
隔列書式を WorksheetTable の該当列に適用するどうかを示す値を取得または設定します。
- value
- タイプ:boolean
備考
列の書式は、WorksheetTable に適用される WorksheetTableStyle によって決まります。こうした書式は、WorksheetTableStyle.areaFormats コレクションに収められ、.ColumnStripe 値および WorksheetTableStyleArea.ColumnStripe 値の参照キーが付けられます。AlternateColumnStripe 値に領域の書式が適用されていない場合、このプロパティはテーブルの表示に影響を与えません。

この値が True であり、かつ、隔列ストライプに関する領域書式がない場合、ストライプの幅は WorksheetTableStyle.columnStripeWidth と WorksheetTableStyle.alternateColumnStripeWidth の値によって定義されます。
関連項目
displayBandedRows

.displayBandedRows( );
隔列書式を WorksheetTable の該当列に適用するどうかを示す値を取得または設定します。
備考
列の書式は、WorksheetTable に適用される WorksheetTableStyle によって決まります。こうした書式は、WorksheetTableStyle.areaFormats コレクションに収められ、WorksheetTableStyleArea.RowStripe 値および WorksheetTableStyleArea.AlternateRowStripe 値の参照キーが付けられます。AlternateRowStripe 値に関して適用される領域書式がない場合、このプロパティはテーブルの表示に影響を与えません。

この値が True であり、かつ、隔列ストライプに関する領域書式がない場合、ストライプの幅は WorksheetTableStyle.rowStripeHeight と WorksheetTableStyle.alternateColumnStripeWidth の値によって定義されます。
関連項目
displayBandedRows

.displayBandedRows( value:boolean );
隔列書式を WorksheetTable の該当列に適用するどうかを示す値を取得または設定します。
- value
- タイプ:boolean
備考
列の書式は、WorksheetTable に適用される WorksheetTableStyle によって決まります。こうした書式は、WorksheetTableStyle.areaFormats コレクションに収められ、WorksheetTableStyleArea.RowStripe 値および WorksheetTableStyleArea.AlternateRowStripe 値の参照キーが付けられます。AlternateRowStripe 値に関して適用される領域書式がない場合、このプロパティはテーブルの表示に影響を与えません。

この値が True であり、かつ、隔列ストライプに関する領域書式がない場合、ストライプの幅は WorksheetTableStyle.rowStripeHeight と WorksheetTableStyle.alternateColumnStripeWidth の値によって定義されます。
関連項目
displayFirstColumnFormatting

.displayFirstColumnFormatting( );
隔列書式を WorksheetTable の該当列に適用するどうかを示す値を取得または設定します。
備考
先頭列の書式は、WorksheetTableStyle に適用されるによって決まります。この書式は、WorksheetTableStyle.areaFormats コレクションに収められ、WorksheetTableStyleArea.FirstColumn 値の参照キーが付けられます。FirstColumn 値に領域の書式が適用されていない場合、このプロパティはテーブルの表示に影響を与えません。

テーブルの列が 1 つだけであるときに先頭列と最終列の両方の書式を適用した場合、最終列の書式が優先されることになります。
関連項目
displayFirstColumnFormatting

.displayFirstColumnFormatting( value:boolean );
隔列書式を WorksheetTable の該当列に適用するどうかを示す値を取得または設定します。
- value
- タイプ:boolean
備考
先頭列の書式は、WorksheetTableStyle に適用されるによって決まります。この書式は、WorksheetTableStyle.areaFormats コレクションに収められ、WorksheetTableStyleArea.FirstColumn 値の参照キーが付けられます。FirstColumn 値に領域の書式が適用されていない場合、このプロパティはテーブルの表示に影響を与えません。

テーブルの列が 1 つだけであるときに先頭列と最終列の両方の書式を適用した場合、最終列の書式が優先されることになります。
関連項目
displayLastColumnFormatting

.displayLastColumnFormatting( );
最後の列書式を WorksheetTable の該当列に適用するどうかを示す値を取得または設定します。
備考
最終列の書式は、WorksheetTable に適用される WorksheetTableStyle によって決まります。この書式は、WorksheetTableStyle.areaFormats コレクションに収められ、WorksheetTableStyleArea.LastColumn 値の参照キーが付けられます。LastColumn 値に関して適用される領域書式がない場合、このプロパティはテーブルの表示に影響を与えません。

テーブルの列が 1 つだけであるときに先頭列と最終列の両方の書式を適用した場合、最終列の書式が優先されることになります。
関連項目
displayLastColumnFormatting

.displayLastColumnFormatting( value:boolean );
最後の列書式を WorksheetTable の該当列に適用するどうかを示す値を取得または設定します。
- value
- タイプ:boolean
備考
最終列の書式は、WorksheetTable に適用される WorksheetTableStyle によって決まります。この書式は、WorksheetTableStyle.areaFormats コレクションに収められ、WorksheetTableStyleArea.LastColumn 値の参照キーが付けられます。LastColumn 値に関して適用される領域書式がない場合、このプロパティはテーブルの表示に影響を与えません。

テーブルの列が 1 つだけであるときに先頭列と最終列の両方の書式を適用した場合、最終列の書式が優先されることになります。
関連項目
headerRowRegion

.headerRowRegion( );

返却型:

ig.excel.WorksheetRegion

返却型の説明:

テーブルのヘッダー行にあるセル領域を表す WorksheetRegion が返されます。ヘッダー行が非表示になっている場合は null 値が返されます。
テーブルのヘッダー行にあるセル領域を表す WorksheetRegion を取得します。
関連項目

insertColumns

.insertColumns( tableColumnIndex:number, [count:number] );

表に 1 つ以上の列を挿入します。

tableColumnIndex
タイプ:number
表の最初の列に対して適用される挿入ポイント。
count
タイプ:number
オプション
挿入する列数

例外

例外	説明
ig.InvalidOperationException	操作が許可されていない場合、例えばワークシートからデータが移動される恐れがある場合。
ig.IndexOutOfRangeException	インデックスが負の数の場合。
ig.ArgumentOutOfRangeException	カウントが 1 より小さい場合。

insertDataRows

.insertDataRows( dataRowIndex:number, [count:number] );

表に 1 つ以上の行を挿入します。

dataRowIndex
タイプ:number
WorksheetTable.dataAreaRegion の最初の行に対して適用される挿入ポイント。
count
タイプ:number
オプション
挿入する列数

例外

例外	説明
ig.InvalidOperationException	操作が許可されていない場合、例えばワークシートからデータが移動される恐れがある場合。
ig.IndexOutOfRangeException	インデックスが負の数の場合。
ig.ArgumentOutOfRangeException	カウントが 1 より小さい場合。

isFilterUIVisible

.isFilterUIVisible( );

フィルターを許可し、テーブルヘッダーにフィルターボタンを表示するかどうかを示す値を取得します。

例外

例外	説明
ig.InvalidOperationException	指定された値は True で、WorksheetTable.isHeaderRowVisible は False です。

備考

WorksheetTable.isHeaderRowVisible が False の場合、このプロパティは False でなければならず、True に設定するとエラーが発生します。 WorksheetTable.isHeaderRowVisible が True に設定されると、このプロパティも自動的に True に設定されます。

isFilterUIVisible

.isFilterUIVisible( value:boolean );

フィルターを許可し、テーブルヘッダーにフィルターボタンを表示するかどうかを示す値を取得します。

value
タイプ:boolean

例外

例外	説明
ig.InvalidOperationException	指定された値は True で、WorksheetTable.isHeaderRowVisible は False です。

備考

isTotalsRowVisible

.isTotalsRowVisible( );
返却型:: boolean
返却型の説明:: 列集計値を含んでいる行が表示される場合は True、非表示の場合は False。

列の合計を含む行を表示するかどうかを示す値を取得します。

例外

例外	説明
ig.InvalidOperationException	この値が True に設定され、テーブルはワークシートの最後の行を占有します。

備考

集計行が表示されている場合、各データ列の下には、集計値やテキスト値を示すセル、もしくは空のセルが表示されます。このセルに集計値を表示するには、WorksheetTableColumn.totalFormula を設定します。テキストのラベルを表示するには、WorksheetTableColumn.totalLabel を設定します。両方を設定した場合、集計値が優先されます。

isTotalsRowVisible

.isTotalsRowVisible( value:boolean );
返却型:: boolean
返却型の説明:: 列集計値を含んでいる行が表示される場合は True、非表示の場合は False。

列の合計を含む行を表示するかどうかを示す値を取得します。

value
タイプ:boolean

例外

例外	説明
ig.InvalidOperationException	この値が True に設定され、テーブルはワークシートの最後の行を占有します。

備考

name
継承

.name( );
返却型:: string
返却型の説明:

例外

例外	説明
ig.ArgumentNullException
ig.ArgumentException
ig.ArgumentException
ig.InvalidOperationException

備考

name
継承

.name( value:string );
返却型:: string
返却型の説明:

value
タイプ:string

例外

例外	説明
ig.ArgumentNullException
ig.ArgumentException
ig.ArgumentException
ig.InvalidOperationException

備考

reapplyFilters

.reapplyFilters( );
テーブル内の列に定義されているフィルターに基づいてテーブル内の全データセルにフィルターを適用しなおします。
備考
フィルターは、テーブルデータの変更に伴って絶えず評価しなおされるというわけではありません。フィルターがテーブルに適用されるのは、テーブル列のフィルターが追加または削除されたときや、ReapplyFilters メソッドが呼び出されたときだけです。

どのテーブル列にもフィルターが設定されていない場合、このメソッドは列データに対して何も行いません。

注: フィルターを評価しなおした場合、テーブル列のフィルター条件を満たしていないセルがあると、そうしたセルの行は表示されなくなります。フィルターアウトされた行がある場合、その行全体がワークシートで非表示になるため、同じ行のデータは、テーブルの外側にあっても表示されなくなります。
関連項目
- ig.excel.WorksheetTable.clearFilters
- ig.excel.WorksheetTableColumn.filter
reapplySortConditions

.reapplySortConditions( );
テーブル内の列に定義されている並べ替え条件に基づいてテーブル内の全データセルに並べ替え条件を適用しなおします。
関連項目
- ig.excel.WorksheetTable.sortSettings
- ig.excel.WorksheetTableColumn.sortCondition

resize

.resize( headerAndDataRegion:ig.excel.WorksheetRegion );

テーブルをワークシートの新しいデータの範囲にサイズ変更します。

headerAndDataRegion
タイプ:ig.excel.WorksheetRegion
表示される場合、1 つ以上のデータ行を持って、重複して、現在のテーブル領域と同じトップ位置を持つテーブルのヘッダーおよびデータの新しい領域。

例外

例外	説明
ig.InvalidOperationException	WorksheetTable がワークシートから削除された場合に発生します。
ig.InvalidOperationException	WorksheetTable がワークシートから削除された場合に発生します。
ig.ArgumentNullException	headerAndDataRegion が null の場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。

備考

合計行が表示される場合、自動的に最後のデータ行の下に配置されます。合計行が新しいテーブル領域にある場合、新しいデータ行の下に移動されます。新しいデータ行が 1 行上に移動されます。

resize

.resize( headerAndDataRegionAddress:string );

テーブルをワークシートの新しいデータの範囲にサイズ変更します。

headerAndDataRegionAddress
タイプ:string
表示される場合、1 つ以上のデータ行を持って、重複して、現在のテーブル領域と同じトップ位置を持つテーブルのヘッダーおよびデータの新しい領域のアドレス。

例外

例外	説明
ig.InvalidOperationException	WorksheetTable がワークシートから削除された場合に発生します。
ig.InvalidOperationException	WorksheetTable がワークシートから削除された場合に発生します。
ig.InvalidOperationException	WorksheetTable がワークシートから削除された場合に発生します。
ig.ArgumentNullException	headerAndDataRegion が null の場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。

備考

resize

.resize( headerAndDataRegionAddress:string, cellReferenceMode:ig.excel.CellReferenceMode );

テーブルをワークシートの新しいデータの範囲にサイズ変更します。

headerAndDataRegionAddress
タイプ:string
表示される場合、1 つ以上のデータ行を持って、重複して、現在のテーブル領域と同じトップ位置を持つテーブルのヘッダーおよびデータの新しい領域のアドレス。
cellReferenceMode
タイプ:ig.excel.CellReferenceMode
セルアドレスを解析する時に使用されるセル参照モード。

例外

例外	説明
ig.InvalidOperationException	WorksheetTable がワークシートから削除された場合に発生します。
ig.InvalidOperationException	WorksheetTable がワークシートから削除された場合に発生します。
ig.InvalidOperationException	WorksheetTable がワークシートから削除された場合に発生します。
ig.ArgumentNullException	headerAndDataRegion が null の場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。
ig.ArgumentException	他のワークシートの headerAndDataRegion またはテーブルのワークシートから移動された場合に発生します。

備考

style

.style( );
返却型:: ig.excel.WorksheetTableStyle
返却型の説明:: 各種テーブル領域書式のデフォルトを定義する WorksheetTableStyle インスタンス。

WorksheetTable で使用するスタイルを取得または設定します。

例外

例外	説明
ig.ArgumentException	指定した値が、Workbook.customTableStyles または Workbook.standardTableStyles コレクションに存在しません。

備考

WorksheetTableStyle はテーブル内の各種領域で使用する書式を定義します。こうした書式は、まだ書式プロパティの設定されていないセルに関するデフォルトとして使用されます。

WorksheetTableStyle に指定した領域書式は差分書式です。つまり、デフォルト以外の値に設定されているプロパティのみが該当セルに適用されます。領域書式で定義できるは、背景色またはフォント情報のみで、その書式はセルに適用されることになりますが、他の書式プロパティはすべて保持されます。

この値を null 値に設定すると、Style は Workbook.defaultTableStyle に設定されます。

style

.style( value:ig.excel.WorksheetTableStyle );
返却型:: ig.excel.WorksheetTableStyle
返却型の説明:: 各種テーブル領域書式のデフォルトを定義する WorksheetTableStyle インスタンス。

WorksheetTable で使用するスタイルを取得または設定します。

value
タイプ:ig.excel.WorksheetTableStyle

例外

例外	説明
ig.ArgumentException	指定した値が、Workbook.customTableStyles または Workbook.standardTableStyles コレクションに存在しません。

備考

この値を null 値に設定すると、Style は Workbook.defaultTableStyle に設定されます。

Ignite UI for jQuery | API リファレンス

ig.excel.WorksheetTable

備考

依存関係