ig.excel.FixedValuesFilter

Represents a filter which can filter cells based on specific, fixed values, which are allowed to display.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.

  • calendarType

    .calendarType( );

    Gets the calendar type used to interpret values in the FixedValuesFilter.dateGroups collection.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the FixedValuesFilter.calendarType enumeration.

  • calendarType

    .calendarType( value:ig.excel.CalendarType );

    Sets the calendar type used to interpret values in the FixedValuesFilter.dateGroups collection.

    • value
    • Type:ig.excel.CalendarType

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the FixedValuesFilter.calendarType enumeration.

  • dateGroups

    .dateGroups( );

    Gets the collection of fixed date groups which should be filtered in.

    See Also

  • dateGroups

    .dateGroups( index:number );

    Gets the fixed date group at the specified index.

    • index
    • Type:number
    • The 0-based index of the value to get or set.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to FixedDateGroupCollection.count.
    ig.ArgumentNullException The value assigned is null.
    ig.ArgumentException The value assigned is already in the collection.

  • dateGroups

    .dateGroups( index:number, value:ig.excel.FixedDateGroup );

    Sets the fixed date group at the specified index.

    • index
    • Type:number
    • The 0-based index of the value to get or set.
    • value
    • Type:ig.excel.FixedDateGroup

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to FixedDateGroupCollection.count.
    ig.ArgumentNullException The value assigned is null.
    ig.ArgumentException The value assigned is already in the collection.

  • displayValues

    .displayValues( );

    Gets the collection of cell text values which should be filtered in.

    Remarks

    Text values are compared case-insensitively.

    Note: If any text values are longer than 255 characters in length and the workbook is saved in one of the 2003 formats, the correct rows will be hidden in the saved file, but the filter may be missing from the column or reapplying the filter may hide some of the matching cells.

    See Also

  • displayValues

    .displayValues( index:number );

    Gets the display text value at the specified index.

    • index
    • Type:number
    • The 0-based index of the value to get or set.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to DisplayValueCollection.count.
    ig.ArgumentNullException The value assigned is null.
    ig.ArgumentException The value assigned matches another value in the collection. Values are compared case-insensitively.

  • displayValues

    .displayValues( index:number, value:string );

    Sets the display text value at the specified index.

    • index
    • Type:number
    • The 0-based index of the value to get or set.
    • value
    • Type:string

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to DisplayValueCollection.count.
    ig.ArgumentNullException The value assigned is null.
    ig.ArgumentException The value assigned matches another value in the collection. Values are compared case-insensitively.

  • includeBlanks

    .includeBlanks( );

    Gets the value which indicates whether blank cells should be filtered in.

    Exceptions

    Exception Description
    ig.InvalidOperationException The value is set to False and both FixedValuesFilter.dateGroups and FixedValuesFilter.displayValues contain no values. This would prevent the filter from including any values, which is not allowed for a FixedValuesFilter.

  • includeBlanks

    .includeBlanks( value:boolean );

    Sets the value which indicates whether blank cells should be filtered in.

    • value
    • Type:boolean

    Exceptions

    Exception Description
    ig.InvalidOperationException The value is set to False and both FixedValuesFilter.dateGroups and FixedValuesFilter.displayValues contain no values. This would prevent the filter from including any values, which is not allowed for a FixedValuesFilter.

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