Ignite UI™ API ヘルプ

ig.excel.WorksheetTableColumn

WorksheetTable の列を表します。

備考

各列は、コンテンツの制御や、列内の書式/並べ替え/フィルター処理に関する各種設定値を備えています。

依存関係

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

詳細の表示

applyAverageFilter

.applyAverageFilter( type:ig.excel.AverageFilterType );

列に AverageFilter を適用します。

type
タイプ:ig.excel.AverageFilterType
データ範囲の平均を下回るデータに絞り込むか、平均を上回るデータに絞り込むかを示す値。

例外

例外	説明
ig.excel.InvalidEnumArgumentException	タイプが AverageFilterType 列挙体で定義されていないです。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

applyCustomFilter

.applyCustomFilter( condition:ig.excel.CustomFilterCondition );

列に CustomFilter を適用します。

condition
タイプ:ig.excel.CustomFilterCondition
データを表示するために一致する必要のある条件。

例外

例外	説明
ig.ArgumentNullException	条件は null です。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

備考

注: フィルター条件値の長さ 255 文字よりも長く、ワークブックが 2003 フォーマットの 1 つで保存される場合、保存されたファイルで正しい行は非表示になりますが、フィルターは列からなくなります。

applyCustomFilter

.applyCustomFilter( condition1:ig.excel.CustomFilterCondition, condition2:ig.excel.CustomFilterCondition, conditionalOperator:ig.excel.ConditionalOperator );

列に CustomFilter を適用します。

condition1
タイプ:ig.excel.CustomFilterCondition
データの絞り込みに使用される第 1 条件。
condition2
タイプ:ig.excel.CustomFilterCondition
データの絞り込みに使用される第 2 条件。
conditionalOperator
タイプ:ig.excel.ConditionalOperator
condition1 および condition2 との論理的な連結を定義する演算子。

例外

例外	説明
ig.ArgumentNullException	条件は null です。
ig.excel.InvalidEnumArgumentException	conditionalOperator が ConditionalOperator 列挙体で定義されていないです。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

備考

applyDatePeriodFilter

.applyDatePeriodFilter( type:ig.excel.DatePeriodFilterType, value:number );

列に DatePeriodFilter を適用します。

type
タイプ:ig.excel.DatePeriodFilterType
表示する日付期間のタイプ。
value
タイプ:number
表示する月または四半期の 1 から始まる値。

例外

例外	説明
ig.excel.InvalidEnumArgumentException	タイプが DatePeriodFilterType 列挙体で定義されていません。
ig.ArgumentException	タイプが Quarter であり、値が 1 未満または 4 を超える値であるか、もしくはタイプが Month で、値が 1 未満または 12 を超える値です。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

備考

タイプが Month である場合、この値に 1 を指定すると January に、2 を指定すると February に日付が絞り込まれるという具合になります。タイプが Quarter の場合、この値に 1 を指定すると Quarter 1 に日付が絞り込まれるという形になります。

applyFillFilter

.applyFillFilter( fill:ig.excel.CellFill );

列に FillFilter を適用します。

fill
タイプ:ig.excel.CellFill
セルのフィルタリングに使用する CellFill。

例外

例外	説明
ig.ArgumentNullException	塗りつぶしは null です。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

applyFixedValuesFilter

.applyFixedValuesFilter( includeBlanks:boolean, calendarType:ig.excel.CalendarType, dateGroups:ig.excel.FixedDateGroup[] );

列に FixedValuesFilter を適用します。

includeBlanks
タイプ:boolean
空のセルを表示するかどうかを示す値。
calendarType
タイプ:ig.excel.CalendarType
dateGroups コレクションに含まれる値の解釈に使用されるカレンダータイプ。
dateGroups
タイプ:ig.excel.FixedDateGroup[]
表示される固定日付グループのコレクション。

例外

例外	説明
ig.ArgumentNullException	dateGroups が null です。
ig.ArgumentNullException	dateGroups が null です。
ig.excel.InvalidEnumArgumentException	calendarType が CalendarType 列挙体で定義されていません。
ig.ArgumentException	dateGroups の複数項目は互いに等しいです。
ig.InvalidOperationException	includeBlanks が False で dateGroups に項目はありません。少なくとも 1 つの値を許可する必要があります。
ig.InvalidOperationException	includeBlanks が False で dateGroups に項目はありません。少なくとも 1 つの値を許可する必要があります。

applyFontColorFilter

.applyFontColorFilter( fontColorInfo:ig.excel.WorkbookColorInfo );

列に FontColorFilter を適用します。

fontColorInfo
タイプ:ig.excel.WorkbookColorInfo
フィルターされるセルに使用するフォントの色を説明する WorkbookColorInfo。

例外

例外	説明
ig.ArgumentNullException	fontColorInfo は null です。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

applyFontColorFilter

.applyFontColorFilter( fontColor:string );

列に FontColorFilter を適用します。

fontColor
タイプ:string
セルの絞り込みに使用するフォントの色。

例外

例外	説明
ig.ArgumentNullException	fontColorInfo は null です。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

applyIconFilter

.applyIconFilter( iconSet:ig.excel.FormatConditionIconSet, iconIndex:number );

iconSet
タイプ:ig.excel.FormatConditionIconSet
iconIndex
タイプ:number

例外

例外	説明
ig.ArgumentException
ig.ArgumentOutOfRangeException
ig.InvalidOperationException
ig.InvalidOperationException
ig.excel.InvalidEnumArgumentException

applyRelativeDateRangeFilter

.applyRelativeDateRangeFilter( offset:ig.excel.RelativeDateRangeOffset, duration:ig.excel.RelativeDateRangeDuration );

列に RelativeDateRangeFilter を適用します。

offset
タイプ:ig.excel.RelativeDateRangeOffset
相対フィルターのオフセット。このタイプのフィルターを期間と組み合わせて使用すると、許容される全日付範囲が決定されます。
duration
タイプ:ig.excel.RelativeDateRangeDuration
許容される全日付範囲の期間です。

例外

例外	説明
ig.excel.InvalidEnumArgumentException	オフセットは RelativeDateRangeOffset 列挙体で定義されていません。
ig.excel.InvalidEnumArgumentException	オフセットは RelativeDateRangeOffset 列挙体で定義されていません。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

備考

RelativeDateRangeFilter では、フィルターの適用日を基点として、1 つ前、現在、または次の期間に含まれる日付に絞り込むことができます。指定できる期間は、日、週、月、四半期、および年です。したがって、期間に day を指定して previous というフィルタータイプを使用すると、「yesterday」というフィルターが作成されます。あるいは、期間に year を指定して current というフィルタータイプを使用すると、「this year」というフィルターが作成されます。ただし、こうしたフィルターは、フィルターの作成日を基準日としてデータを評価します。したがって、1999 年に作成された「this year」というフィルターを使用すると、たとえ 2012 年にワークブックを開いたとしても、1999 年の日付を含むセルがすべて表示されることになります。

applyTopOrBottomFilter

.applyTopOrBottomFilter( );

TopOrBottomFilter に並べ替えられた値リストで上位 10 番目までに入る値を絞り込む列に TopOrBottomFilter を適用します。

例外

例外	説明
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

applyTopOrBottomFilter

.applyTopOrBottomFilter( type:ig.excel.TopOrBottomFilterType, value:number );

TopOrBottomFilter に並べ替えられた値リストで上位 10 番目までに入る値を絞り込む列に TopOrBottomFilter を適用します。

type
タイプ:ig.excel.TopOrBottomFilterType
このフィルターのタイプ。
value
タイプ:number
表示する値の数またはパーセンテージ。

例外

例外	説明
ig.excel.InvalidEnumArgumentException	タイプが TopOrBottomFilterType 列挙体で定義されていません。
ig.ArgumentOutOfRangeException	ataiata値が、1 未満、または 500 を超える値です。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

applyYearToDateFilter

.applyYearToDateFilter( );

列に YearToDateFilter を適用します。

例外

例外	説明
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。
ig.InvalidOperationException	所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。ヘッダー行またはフィルターボタンが非表示の時にフィルターを適用できません。

areaFormats

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

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

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

例外

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

clearFilter

.clearFilter( );

適用される場合、列からフィルターを削除します。

例外

例外	説明
ig.InvalidOperationException	列がテーブルから削除された場合。

name

.name( );
返却型:: string
返却型の説明:: 所属する WorksheetTable 内における一意の列名。

列の名前を取得します。

例外

例外	説明
ig.InvalidOperationException	セッターで列がテーブルから削除された場合、エラーは発生されます。

備考

WorksheetTable にヘッダー行が表示される場合、この列の名前がヘッダー行の列セルに表示されます。

WorksheetTable を作成すると、列の名前はヘッダー行のセルから取り込まれることになります。テーブルにヘッダー行が含まれていない場合、列の名前は自動的に生成されます。

列の名前は、親 WorksheetTable 内における一意の名前です。テーブルの作成時に同名の列が 2 つ以上存在する場合、各列を一意に識別できるように 2 番目以降の重複列名の末尾に番号が振られていきます。ヘッダー行のセルのなかに文字列以外の値を持つものがある場合、その値は文字列 (そのセルの現在の表示テキスト) に変換されます。ヘッダー行のセルに値を持たないものがある場合、それらのセルには生成された列名が与えられます。

Name プロパティを null 値または空の文字列に設定した場合、列の名前は自動的に生成されます。指定した列名がすでにテーブル内に存在する場合、すべての列を一意に識別できるよう、インデックス値の大きな列には列名の末尾に番号が付けられることになります。

name

.name( value:string );
返却型:: string
返却型の説明:: 所属する WorksheetTable 内における一意の列名。

列の名前を取得します。

value
タイプ:string

例外

例外	説明
ig.InvalidOperationException	セッターで列がテーブルから削除された場合、エラーは発生されます。

備考

WorksheetTable にヘッダー行が表示される場合、この列の名前がヘッダー行の列セルに表示されます。

setColumnFormula

.setColumnFormula( formula:ig.excel.Formula, overwriteExistingValues:boolean );

この列のデータセルで使用する数式を設定します。

formula
タイプ:ig.excel.Formula
この列のデータセルで使用したい数式を指定します。null 値を指定すると、現在の列に設定されている数式が削除されます。
overwriteExistingValues
タイプ:boolean
既存のセル値を上書きして、この列の全データセルに数式を適用したい場合は true に設定します。値が設定されていないセルにのみ数式を適用したい場合は False に設定します。

例外

例外	説明
ig.ArgumentException	列がテーブルから削除された場合数式は、セルやテーブル列など他のものに適用されます。

備考

指定した数式に相対セル参照や相対領域参照が含まれている場合、実際の数式は当該の列にある最初のデータセルに適用するものとみなされます。この数式が列内の他のセルに適用される場合、相対参照値が適切な量だけずらされます。

列の数式を設定し、テーブルのサイズを変更して列の数を増やした場合、その列内の新しいセルには、その列の数式が適用されることになります。

以前に適用された別の列数式があって、列内のいずれかのセルにその数式が適用されている場合、その数式を別の数式に変更すると、セルに適用されていた以前の数式は、overwriteExistingValues の値に関係なく上書きされることになります。

sortCondition

.sortCondition( );
返却型:: ig.excel.SortCondition
返却型の説明:: 列の並べ替えに使用される WorksheetTableColumn.sortCondition 派生インスタンスが返されます。列の並べ替えが行われない場合は null 値が返されます。

テーブル内での列の並べ替えに使用される並べ替え条件を取得します。

例外

例外	説明
ig.InvalidOperationException	セッターで列がテーブルから削除された場合、エラーは発生されます。

備考

並べ替え条件を列に設定すると、WorksheetTable.sortSettings の SortConditions コレクションがクリアされ、新しい並べ替え条件が追加されます。複数列で並べ替えるには、列で設定する代わりに並べ替え条件を SortConditions コレクションに追加する必要があります。ただし、並べ替え条件をこのプロパティでクリアすると、その列の並べ替え条件は SortConditions コレクションから削除されます。その他すべての SortConditions はコレクションに残ります。

注: 並べ替え条件は、テーブルデータの変更に伴って常に評価されるというわけではありません。並べ替え条件がテーブルに適用されるのは、テーブル列のフィルターが追加または削除されたときや、WorksheetTable.reapplySortConditions メソッドが呼び出されたときだけです。

sortCondition

.sortCondition( value:ig.excel.SortCondition );
返却型:: ig.excel.SortCondition
返却型の説明:: 列の並べ替えに使用される WorksheetTableColumn.sortCondition 派生インスタンスが返されます。列の並べ替えが行われない場合は null 値が返されます。

テーブル内での列の並べ替えに使用される並べ替え条件を取得します。

value
タイプ:ig.excel.SortCondition

例外

例外	説明
ig.InvalidOperationException	セッターで列がテーブルから削除された場合、エラーは発生されます。

備考

totalFormula

.totalFormula( );
返却型:: ig.excel.Formula
返却型の説明:

この列のすべてのセルで使用する数式を取得または設定します。

例外

例外	説明
ig.ArgumentException	この値は、セルやテーブル列といった他の領域にすでに適用されています。
ig.InvalidOperationException	セッターで列がテーブルから削除された場合、エラーは発生されます。

備考

集計式は、集計行の表示/非表示に関係なく設定できます。集計行が非表示になっている場合、集計式はどこにも適用されません。集計行が表示される場合は、この列の集計セルに集計行が適用されることになります。

TotalFormula を null 以外の値に設定すると、WorksheetTableColumn.totalLabel がクリアされ、逆に設定しても同様にクリアされます。

totalFormula

.totalFormula( value:ig.excel.Formula );
返却型:: ig.excel.Formula
返却型の説明:

この列のすべてのセルで使用する数式を取得または設定します。

value
タイプ:ig.excel.Formula

例外

例外	説明
ig.ArgumentException	この値は、セルやテーブル列といった他の領域にすでに適用されています。
ig.InvalidOperationException	セッターで列がテーブルから削除された場合、エラーは発生されます。

備考

TotalFormula を null 以外の値に設定すると、WorksheetTableColumn.totalLabel がクリアされ、逆に設定しても同様にクリアされます。

totalLabel

.totalLabel( );

この列の集計セルで使用するテキストラベルを取得します。

例外

例外	説明
ig.InvalidOperationException	セッターで列がテーブルから削除された場合、エラーは発生されます。

備考

集計ラベルは、集計行の表示/非表示に関係なく設定できます。集計行が非表示になっている場合、ラベルはどこにも適用されません。集計行が表示される場合は、ラベルがこの列の集計セルの値として設定されることになります。

WorksheetTableColumn.totalFormula を null 以外の値に設定すると、TotalLabel がクリアされ、逆に設定しても同様にクリアされます。

totalLabel

.totalLabel( value:string );

この列の集計セルで使用するテキストラベルを取得します。

value
タイプ:string

例外

例外	説明
ig.InvalidOperationException	セッターで列がテーブルから削除された場合、エラーは発生されます。

備考

WorksheetTableColumn.totalFormula を null 以外の値に設定すると、TotalLabel がクリアされ、逆に設定しても同様にクリアされます。

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

ig.excel.WorksheetTableColumn

備考

依存関係