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.

  • clearRegion

    .clearRegion( );

    Clears the region as well as any existing sort criteria

    See Also

  • initializeRegion

    .initializeRegion( );

    Initializes the region to null

  • reapplySortConditions

    .reapplySortConditions( );

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

    See Also

  • region

    .region( );

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

    See Also

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

    See Also

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

    See Also

  • sortType

    .sortType( );

    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 );

    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 - 2024 Infragistics, Inc. All rights reserved.