ig.excel.SortConditionCollection`1

An ordered collection of sort conditions which are applied to a sort-able regions in a worksheet.

Remarks

The sort conditions in the collection are applied in order to the data.

Note: The collection can hold a maximum of 64 sort condition.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.

  • add

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

    Adds a sort condition to the collection.

    • sortableItem
    • Type:ig.excel.T
    • The sort-able item over which the sort condition will be applied.
    • sortCondition
    • Type:ig.excel.SortCondition
    • The sort condition to apply to the sort-able item.

    Exceptions

    Exception Description
    ig.ArgumentNullException sortableItem is null.
    ig.ArgumentNullException sortCondition is null.
    ig.ArgumentException sortableItem is already has a sort condition applied to it in the collection.
    ig.InvalidOperationException There are already 64 sort conditions in the collection.

  • clear

    .clear( );

    Clears the collection.

  • contains

    .contains( sortCondition:ig.excel.SortCondition );
    Return Type:
    boolean
    Return Type Description:
    True if the sort condition is in the collection; False otherwise.

    Determines whether the specified sort condition is in the collection.

    • sortCondition
    • Type:ig.excel.SortCondition
    • The sort condition to find in the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException sortCondition is null.

  • contains

    .contains( sortableItem:ig.excel.T );
    Return Type:
    boolean
    Return Type Description:
    True if the sort-able item is in the collection; False otherwise.

    Determines whether the specified sort-able item is in the collection.

    • sortableItem
    • Type:ig.excel.T
    • The sort-able item to find in the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException sortableItem is null.

  • count

    .count( );

    Gets the number of sort conditions in the collection.

  • indexOf

    .indexOf( sortCondition:ig.excel.SortCondition );
    Return Type:
    number
    Return Type Description:
    The 0-based index of the specified sort condition in the collection or -1 if the item is not in the collection.

    Gets the index of the specified sort condition in the collection.

    • sortCondition
    • Type:ig.excel.SortCondition
    • The sort condition to find in the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException sortCondition is null.

  • indexOf

    .indexOf( sortableItem:ig.excel.T );
    Return Type:
    number
    Return Type Description:
    The 0-based index of the specified sort-able item in the collection or -1 if the item is not in the collection.

    Gets the index of the specified sort-able item in the collection.

    • sortableItem
    • Type:ig.excel.T
    • The sort-able item to find in the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException sortableItem is null.

  • insert

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

    Inserts a sort condition into the collection.

    • index
    • Type:number
    • The 0-based index where the sort condition should be inserted.
    • sortableItem
    • Type:ig.excel.T
    • The sort-able item over which the sort condition will be applied.
    • sortCondition
    • Type:ig.excel.SortCondition
    • The sort condition to apply to the sort-able item.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than 0 or greater than SortConditionCollection`1.count.
    ig.ArgumentNullException sortableItem is null.
    ig.ArgumentNullException sortCondition is null.
    ig.ArgumentException sortableItem is already has a sort condition applied to it in the collection.
    ig.InvalidOperationException There are already 64 sort conditions in the collection.

  • item

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

    Gets the sort condition for the specified sort-able item.

    • sortableItem
    • Type:ig.excel.T
    • The sort-able item for which to get or set the sort condition.

    Exceptions

    Exception Description
    ig.ArgumentNullException sortableItem is null.
    ig.InvalidOperationException The sort-able item is not already in the collection and there are already 64 sort conditions in the collection.

  • item

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

    Sets the sort condition for the specified sort-able item.

    • sortableItem
    • Type:ig.excel.T
    • The sort-able item for which to get or set the sort condition.
    • value
    • Type:ig.excel.SortCondition

    Exceptions

    Exception Description
    ig.ArgumentNullException sortableItem is null.
    ig.InvalidOperationException The sort-able item is not already in the collection and there are already 64 sort conditions in the collection.

  • item

    .item( index:number );

    Gets the pair of item and sort condition at the specified index.

    • index
    • Type:number
    • The index at which to get the pair of item and sort condition.

    Exceptions

    Exception Description
    ig.ArgumentNullException The Key or Value of the assigned value is null.
    ig.InvalidOperationException The Key of the assigned value already in the collection at a different index.

  • item

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

    Sets the pair of item and sort condition at the specified index.

    • index
    • Type:number
    • The index at which to get the pair of item and sort condition.
    • value
    • Type:ig.KeyValuePair`2

    Exceptions

    Exception Description
    ig.ArgumentNullException The Key or Value of the assigned value is null.
    ig.InvalidOperationException The Key of the assigned value already in the collection at a different index.

  • remove

    .remove( sortableItem:ig.excel.T );
    Return Type:
    boolean
    Return Type Description:
    True if the sort-able item was found and removed; False otherwise.

    Removes a sort-able item from the collection.

    • sortableItem
    • Type:ig.excel.T
    • The sort-able item to remove from the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException sortableItem is null.

  • remove

    .remove( sortCondition:ig.excel.SortCondition );
    Return Type:
    boolean
    Return Type Description:
    True if the sort condition was found and removed; False otherwise.

    Removes a sort condition from the collection.

    • sortCondition
    • Type:ig.excel.SortCondition
    • The sort condition to remove from the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException sortCondition is null.

  • removeAt

    .removeAt( index:number );

    Removes the sort condition at the specified index.

    • index
    • Type:number
    • The 0-based index of the sort condition to remove.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to SortConditionCollection`1.count.

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.