Ignite UI API Reference

ig.excel.CustomFilter

Represents a filter which can filter data based on one or two custom conditions.

Remarks

This filter type allows you to specify one or two filter conditions which have a comparison operator and value. These two filter conditions can be combined with a logical and or a logical or operation.

Dependencies

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

    .condition1( );

    Gets the first condition by which to filter the cells in the data range.

    Exceptions

    Exception Description
    ig.ArgumentNullException The value assigned is null.

    Remarks

    The first filter condition is required. Setting Condition1 to null will cause an exception to be thrown.

    When both Condition1 and CustomFilter.condition2 are set, the CustomFilter.conditionalOperator is used to determine how the conditions should be logically combined.

  • condition1

    .condition1( value:ig.excel.CustomFilterCondition );

    Sets the first condition by which to filter the cells in the data range.

    • value
    • Type:ig.excel.CustomFilterCondition

    Exceptions

    Exception Description
    ig.ArgumentNullException The value assigned is null.

    Remarks

    The first filter condition is required. Setting Condition1 to null will cause an exception to be thrown.

    When both Condition1 and CustomFilter.condition2 are set, the CustomFilter.conditionalOperator is used to determine how the conditions should be logically combined.

  • condition2

    .condition2( );

    Gets the second condition by which to filter the cells in the data range.

    Remarks

    The second filter condition is optional. A value of null indicates that only CustomFilter.condition1 should be used to filter the data.

    When both Condition1 and Condition2 are set, the CustomFilter.conditionalOperator is used to determine how the conditions should be logically combined.

  • condition2

    .condition2( value:ig.excel.CustomFilterCondition );

    Sets the second condition by which to filter the cells in the data range.

    • value
    • Type:ig.excel.CustomFilterCondition

    Remarks

    The second filter condition is optional. A value of null indicates that only CustomFilter.condition1 should be used to filter the data.

    When both Condition1 and Condition2 are set, the CustomFilter.conditionalOperator is used to determine how the conditions should be logically combined.

  • conditionalOperator

    .conditionalOperator( );
    Return Type:
    ig.excel.ConditionalOperator
    Return Type Description:
    And to require both conditions to pass for the data to be filtered in. Or to allow data to be filtered in when one or both conditions are met.

    Gets the operator which defines how to logically combine CustomFilter.condition1 and CustomFilter.condition2

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the CustomFilter.conditionalOperator enumeration.

    Remarks

    When both Condition1 and Condition2 are set, the ConditionalOperator is used to determine how the conditions should be logically combined. If only Condition1 is set and Condition2 is null, then ConditionalOperator is ignored.

  • conditionalOperator

    .conditionalOperator( value:ig.excel.ConditionalOperator );
    Return Type:
    ig.excel.ConditionalOperator
    Return Type Description:
    And to require both conditions to pass for the data to be filtered in. Or to allow data to be filtered in when one or both conditions are met.

    Sets the operator which defines how to logically combine CustomFilter.condition1 and CustomFilter.condition2

    • value
    • Type:ig.excel.ConditionalOperator

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the CustomFilter.conditionalOperator enumeration.

    Remarks

    When both Condition1 and Condition2 are set, the ConditionalOperator is used to determine how the conditions should be logically combined. If only Condition1 is set and Condition2 is null, then ConditionalOperator is ignored.

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

#