ig.excel.FontColorSortCondition

Represents a sort condition which will sort cells based on their fonts colors.

Remarks

This sort condition specifies a single color. 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
The current widget has no options.
The current widget has no events.

  • ig.excel.FontColorSortCondition
    Constructor

    new $.ig.excel.FontColorSortCondition( fontColorInfo:ig.excel.WorkbookColorInfo );

    Creates a new FontColorSortCondition instance.

    • fontColorInfo
    • Type:ig.excel.WorkbookColorInfo
    • The color by which the cells should be sorted.

    Exceptions

    Exception Description
    ig.ArgumentNullException fontColorInfo is null.

  • ig.excel.FontColorSortCondition
    Constructor

    new $.ig.excel.FontColorSortCondition( fontColorInfo:ig.excel.WorkbookColorInfo, sortDirection:ig.excel.SortDirection );

    Creates a new FontColorSortCondition instance.

    • fontColorInfo
    • Type:ig.excel.WorkbookColorInfo
    • A WorkbookColorInfo which describes the color 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 fontColorInfo 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 FontColorSortCondition is equal to the specified object.

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

  • fontColorInfo

    .fontColorInfo( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    The WorkbookColorInfo which describes the color by which the cells should be sorted.

    Gets the WorkbookColorInfo which describes the color by which the cells should be sorted.

    Remarks

    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.

    See Also

  • getHashCode

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

    Gets the hash code for the FontColorSortCondition.

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