ig.excel.WorksheetSortSettings

Exposes methods to identify a region in the wroksheet and to apply sort criteria to that 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.

  • clearRegion

    .clearRegion( );

    Clears the region as well as any existing sort criteria

  • initializeRegion

    .initializeRegion( );

    Initializes the region to null

  • reapplySortConditions

    .reapplySortConditions( );

    Re-sorts all data cells in the region based on the sort conditions.

  • region

    .region( );
    Return Type:
    ig.excel.WorksheetRegion
    Return Type Description:
    Returns a WorksheetRegion.

    Returns the region that the filter settings is applied to (read-only).

  • setRegion

    .setRegion( address:string );

    Sets the region where the filter settings should be applied

    • address
    • Type:string
    • The address of the new region.

    Exceptions

    Exception Description
    ig.InvalidOperationException If the region intersects with a table of other reserved area in the worksheet.

    Remarks

    The Workbook.cellReferenceMode of the workbook will be used to parse the region address.

    Note: setting the region will clear any applied filters or sort criteria.

  • setRegion

    .setRegion( address:string, cellReferenceMode:ig.excel.CellReferenceMode );

    Sets the region where the filter settings should be applied

    • address
    • Type:string
    • The address of the new region.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • The reference to use the parse the address.

    Exceptions

    Exception Description
    ig.InvalidOperationException If the region intersects with a table of other reserved area in the worksheet.

    Remarks

    Note: setting the region will clear any applied filters or sort criteria.

  • 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.

  • 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.
  • 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.
  • 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.
  • sortType

    .sortType( );
    Return Type:
    ig.excel.WorksheetSortType
    Return Type Description:
    Returns a WorksheetSortType.

    Determines whether columns or rows will be sorted within the region. 'Rows' is the default.

    Remarks

    Note: when this property is changed all existing sort conditions will be cleared so this property should be set before sort conditions are added.
  • sortType

    .sortType( value:ig.excel.WorksheetSortType );
    Return Type:
    ig.excel.WorksheetSortType
    Return Type Description:
    Returns a WorksheetSortType.

    Determines whether columns or rows will be sorted within the region. 'Rows' is the default.

    • value
    • Type:ig.excel.WorksheetSortType

    Remarks

    Note: when this property is changed all existing sort conditions will be cleared so this property should be set before sort conditions are added.

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