Ignite UI™ API ヘルプ

ig.excel.SortConditionCollection`1

ワークシートの並べ替え可能な領域に適用される並べ替え条件の順序付きコレクション。

備考

コレクションの並べ替え条件はデータの順序で適用されます。

注: このコレクションには最大 64 件の並べ替え条件を収めることができます。

依存関係

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

詳細の表示

addItem

.addItem( sortableItem:ig.excel.T, sortCondition:ig.excel.SortCondition );

sortableItem
タイプ:ig.excel.T
sortCondition
タイプ:ig.excel.SortCondition

例外

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

addRange

.addRange( entries:ig.IEnumerable`1 );

entries
タイプ:ig.IEnumerable`1

例外

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

clear

.clear( );
コレクションを消去します。

contains

.contains( sortCondition:ig.excel.SortCondition );
返却型:: boolean
返却型の説明:: この並べ替え条件がコレクションに含まれている場合は True、そうでない場合は False。

指定した並べ替え条件がこのコレクションに含まれているかどうかを調べます。

sortCondition
タイプ:ig.excel.SortCondition
このコレクションに含まれているかどうかを調べたい並べ替え条件。

例外

例外	説明
ig.ArgumentNullException	sortCondition は null です。

contains

.contains( sortableItem:ig.excel.T );
返却型:: boolean
返却型の説明:: この並べ替え条件がコレクションに含まれている場合は True、そうでない場合は False。

指定した並べ替え条件がこのコレクションに含まれているかどうかを調べます。

sortableItem
タイプ:ig.excel.T
このコレクションに含まれているかどうかを調べたい並べ替え可能項目。

例外

例外	説明
ig.ArgumentNullException	sortCondition は null です。

count

.count( );
このコレクションに含まれている並べ替え条件の数を取得します。

indexOf

.indexOf( sortCondition:ig.excel.SortCondition );
返却型:: number
返却型の説明:: コレクション内における指定した並べ替え条件のインデックス (ゼロを基準とした数値) が返されます。指定した並べ替え条件がこのコレクションに含まれていない場合は -1 が返されます。

コレクション内における指定した並べ替え条件のインデックスを取得します。

sortCondition
タイプ:ig.excel.SortCondition
このコレクションに含まれているかどうかを調べたい並べ替え条件。

例外

例外	説明
ig.ArgumentNullException	sortCondition は null です。

indexOf

.indexOf( sortableItem:ig.excel.T );
返却型:: number
返却型の説明:: コレクション内における指定した並べ替え条件のインデックス (ゼロを基準とした数値) が返されます。指定した並べ替え条件がこのコレクションに含まれていない場合は -1 が返されます。

コレクション内における指定した並べ替え条件のインデックスを取得します。

sortableItem
タイプ:ig.excel.T
このコレクションに含まれているかどうかを調べたい並べ替え可能項目。

例外

例外	説明
ig.ArgumentNullException	sortCondition は null です。

insert

.insert( index:number, sortableItem:ig.excel.T, sortCondition:ig.excel.SortCondition );

このコレクションに並べ替え条件を挿入します。

index
タイプ:number
この並べ替え条件の挿入位置を表すインデックス (ゼロを基準とした数値)。
sortableItem
タイプ:ig.excel.T
並べ替え条件の適用対象となる並べ替え可能な項目。
sortCondition
タイプ:ig.excel.SortCondition
並べ替え可能な項目に適用する並べ替え条件。

例外

例外	説明
ig.ArgumentOutOfRangeException	index が、0 未満、または SortConditionCollection`1.count を超える値です。
ig.ArgumentNullException	sortableItem は null です。
ig.ArgumentNullException	sortableItem は null です。
ig.ArgumentException	sortableItem に適用される並べ替え条件がすでにこのコレクションの中に定義されています。
ig.InvalidOperationException	このコレクションには 64 件の並べ替え条件があります。

insertRange

.insertRange( index:number, entries:ig.IEnumerable`1 );

index
タイプ:number
entries
タイプ:ig.IEnumerable`1

例外

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

item

.item( sortableItem:ig.excel.T );

指定した並べ替え可能項目の並べ替え条件を取得します。

sortableItem
タイプ:ig.excel.T
並べ替え条件を取得または設定する並べ替え可能項目。

例外

例外	説明
ig.ArgumentNullException	sortableItem は null です。
ig.InvalidOperationException	この並べ替え可能項目はまだコレクション内に存在せず、このコレクションにはすでに 64 件の並べ替え条件が存在します。

item

.item( sortableItem:ig.excel.T, value:ig.excel.SortCondition );

指定した並べ替え可能項目の並べ替え条件を取得します。

sortableItem
タイプ:ig.excel.T
並べ替え条件を取得または設定する並べ替え可能項目。
value
タイプ:ig.excel.SortCondition

例外

例外	説明
ig.ArgumentNullException	sortableItem は null です。
ig.InvalidOperationException	この並べ替え可能項目はまだコレクション内に存在せず、このコレクションにはすでに 64 件の並べ替え条件が存在します。

item

.item( index:number );

指定した並べ替え可能項目の並べ替え条件を取得します。

index
タイプ:number
項目および並べ替え条件の組み合わせを取得するインデックス。

例外

例外	説明
ig.ArgumentNullException	sortableItem は null です。
ig.InvalidOperationException	この並べ替え可能項目はまだコレクション内に存在せず、このコレクションにはすでに 64 件の並べ替え条件が存在します。

item

.item( index:number, value:ig.KeyValuePair`2 );

指定した並べ替え可能項目の並べ替え条件を取得します。

index
タイプ:number
項目および並べ替え条件の組み合わせを取得するインデックス。
value
タイプ:ig.KeyValuePair`2

例外

例外	説明
ig.ArgumentNullException	sortableItem は null です。
ig.InvalidOperationException	この並べ替え可能項目はまだコレクション内に存在せず、このコレクションにはすでに 64 件の並べ替え条件が存在します。

remove

.remove( sortCondition:ig.excel.SortCondition );
返却型:: boolean
返却型の説明:: この並べ替え可能項目が見つかって削除された場合は True、そうでない場合は False。

このコレクションから並べ替え可能項目を削除します。

sortCondition
タイプ:ig.excel.SortCondition
コレクションから削除する並べ替え条件。

例外

例外	説明
ig.ArgumentNullException	sortableItem は null です。

removeAt

.removeAt( index:number );

インデックスを指定して並べ替え条件を削除します。

index
タイプ:number
削除する並べ替え条件のインデックス (ゼロを基準とした数値)。

例外

例外	説明
ig.ArgumentOutOfRangeException	index が 0 未満、または SortConditionCollection`1.count 以上の値です。

removeItem

.removeItem( sortableItem:ig.excel.T );
返却型:: boolean
返却型の説明:

sortableItem
タイプ:ig.excel.T

例外

例外	説明
ig.ArgumentNullException

replaceAll

.replaceAll( entries:ig.IEnumerable`1 );

entries
タイプ:ig.IEnumerable`1

例外

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

Ignite UI | サンプル

ig.excel.SortConditionCollection`1

備考

依存関係