ig.excel.CustomListSortCondition

Represents a sort condition which will sort cells based on a custom, ordered list of values.

Remarks

When the sort direction is ascending, the data range is sorted with the cells in the custom list appearing first, in the order they appear in the list, followed by the other cells in the same relative order they had to each other before the sort. When the sort direction is descending, the cells not in the list will appear first in the data region and they will appear in the same relative order they had before the sort. They will be followed by the other cells in the reverse order of the list.

The list of values specified on this sort condition are string values. If a cell being sorted has a string value, that value is used to sort the cell. Otherwise, the cell text is used. For example, if the cell's value is 0.01, but it is formatted as a percentage cell, the text used to sort it with this sort condition will be "1%" and not "0.01". When using the cell text, if the format string for the cell includes padding characters which are repeated across the cells, they will not be included in the cell text used for comparison.

When matching values from a cell to values in the custom list, strings are compared case-sensitively or case-insensitively based on the SortSettings`1.caseSensitive setting.

If the cell text contains any repeated padding characters, they are ignored when comparing strings.

Dependencies

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
The current widget has no options.
The current widget has no events.
  • ig.excel.CustomListSortCondition
    Constructor

    new $.ig.excel.CustomListSortCondition( sortDirection:ig.excel.SortDirection, list:string[] );

    Creates a new CustomListSortCondition instance.

    • sortDirection
    • Type:ig.excel.SortDirection
    • The direction with which to sort the data.
    • list
    • Type:string[]
    • The list of values in the order in which they should be sorted.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException sortDirection is not defined in the SortDirection enumeration.

    Remarks

    When the sort direction is ascending, the data range is sorted with the cells in the custom list appearing first, in the order they appear in the list, followed by the other cells in the same relative order they had to each other before the sort. When the sort direction is descending, the cells not in the list will appear first in the data region and they will appear in the same relative order they had before the sort. They will be followed by the other cells in the reverse order of the list.

  • equals

    .equals( obj:object );
    Return Type:
    boolean
    Return Type Description:
    True if the object is equal to this instance; False otherwise.

    Determines whether the CustomListSortCondition is equal to the specified object.

    • obj
    • Type:object
    • The object to test for equality.
  • getHashCode

    .getHashCode( );
    Return Type:
    number
    Return Type Description:
    A number which can be used to hash this instance.

    Gets the hash code for the CustomListSortCondition.

  • list

    .list( );

    Gets the ordered list of values by which to sort.

    Remarks

    The list of values specified on this sort condition are string values. If a cell being sorted has a string value, that value is used to sort the cell. Otherwise, the cell text is used. For example, if the cell's value is 0.01, but it is formatted as a percentage cell, the text used to sort it with this sort condition will be "1%" and not "0.01". When using the cell text, if the format string for the cell includes padding characters which are repeated across the cells, they will not be included in the cell text used for comparison.

    When matching values from a cell to values in the custom list, strings are compared case-sensitively or case-insensitively based on the SortSettings`1.caseSensitive setting.

    If the cell text contains any repeated padding characters, they are ignored when comparing strings.

  • sortDirection
    Inherited

    .sortDirection( );
    Return Type:
    ig.excel.SortDirection
    Return Type Description:
    Either SortDirection.Ascending or SortDirection.Descending.

    Gets the value which indicates the sort direction represented by the sort condition.

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