ig.excel.RelativeIndexSortSettings

Represents the settings which apply to sorting a region of values based on indices relative to either the Worksheet's Worksheet.filterSettings or Worksheet.sortSettings region.

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.

  • caseSensitive
    Inherited

    .caseSensitive( );
    Return Type:
    boolean
    Return Type Description:
    True to sort strings case-sensitively; False to ignore case.

    Gets the value which indicates whether strings should be compared case-sensitively when they are sorted.

    Remarks

    This is only applicable to sort conditions which sort strings.

  • caseSensitive
    Inherited

    .caseSensitive( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    True to sort strings case-sensitively; False to ignore case.

    Sets the value which indicates whether strings should be compared case-sensitively when they are sorted.

    • value
    • Type:boolean

    Remarks

    This is only applicable to sort conditions which sort strings.

  • initializeRegion

    .initializeRegion( );

    Initializes the region to null

  • sortConditions
    Inherited

    .sortConditions( );
    Return Type:
    ig.excel.SortConditionCollection`1
    Return Type Description:
    Returns a SortConditionCollection`1.

    Gets the collection of sort conditions to use when sorting the region of data.

    Remarks

    If these settings are used in a WorksheetTable, each sort condition in the collection applies to a WorksheetTableColumn.

    This collection is ordered based on precedence. The first sort condition in the collection has the highest sort precedence.

    See Also

  • sortConditions
    Inherited

    .sortConditions( sortableItem:ig.excel.RelativeIndex );
    Return Type:
    ig.excel.SortCondition
    Return Type Description:
    Returns a SortCondition.

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

    • sortableItem
    • Type:ig.excel.RelativeIndex
    • 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.

    See Also

  • sortConditions
    Inherited

    .sortConditions( sortableItem:ig.excel.RelativeIndex, value:ig.excel.SortCondition );
    Return Type:
    ig.excel.SortCondition
    Return Type Description:
    Returns a SortCondition.

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

    • sortableItem
    • Type:ig.excel.RelativeIndex
    • 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.

    See Also

  • sortConditions
    Inherited

    .sortConditions( 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.

  • sortConditions
    Inherited

    .sortConditions( 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.

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