ig.excel.FillSortCondition

Represents a sort condition which will sort cells based on their background fill.

Remarks

This sort condition specifies a single CellFill. Cells of this color will be moved to the beginning of the data range for the ascending sort direction and moved to the end of the data range for the descending sort direction. All matching cells will be kept in their same relative order to each other. In addition, all non-matching cells will be kept in their same relative order to each other.

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.FillSortCondition
    Constructor

    new $.ig.excel.FillSortCondition( fill:ig.excel.CellFill );

    Creates a new FillSortCondition instance.

    • fill
    • Type:ig.excel.CellFill
    • The CellFill by which the cells should be sorted.

    Exceptions

    Exception Description
    ig.ArgumentNullException fill is null.
  • ig.excel.FillSortCondition
    Constructor

    new $.ig.excel.FillSortCondition( fill:ig.excel.CellFill, sortDirection:ig.excel.SortDirection );

    Creates a new FillSortCondition instance.

    • fill
    • Type:ig.excel.CellFill
    • The CellFill by which the cells should be sorted.
    • sortDirection
    • Type:ig.excel.SortDirection
    • The direction by which to sort the cells.

    Exceptions

    Exception Description
    ig.ArgumentNullException fill is null.
    ig.excel.InvalidEnumArgumentException sortDirection is not defined in the SortDirection enumeration.
  • equals

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

    Determines whether the FillSortCondition is equal to the specified object.

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

    .fill( );
    Return Type:
    ig.excel.CellFill
    Return Type Description:
    The CellFill by which the cells should be sorted.

    Gets the CellFill by which the cells should be sorted.

    Remarks

    Cells with this fill will be moved to the beginning of the data range for the ascending sort direction and moved to the end of the data range for the descending sort direction. All matching cells will be kept in their same relative order to each other. In addition, all non-matching cells will be kept in their same relative order to each other.

  • getHashCode

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

    Gets the hash code for the FillSortCondition.

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