ig.excel.CustomFilterCondition
Remarks
The CustomFilterCondition contains a comparison operator and a value. The value of each cell in the data range is compared against the condition value using the comparison operator.
Dependencies
-
ig.excel.CustomFilterCondition
Constructor- new $.ig.excel.CustomFilterCondition( comparisonOperator:ig.excel.ExcelComparisonOperator, value:object );
Creates a new CustomFilterCondition instance.
- comparisonOperator
- Type:ig.excel.ExcelComparisonOperator
- The operator which describes how the cell values should be compared against value.
- value
- Type:object
- The number, string, or date against which the cell values should be compared. The string can contains wild cards for any character (?) or for zero or more characters (*).
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException comparisonOperator is not defined in the ExcelComparisonOperator enumeration. ig.ArgumentException value is infinity or NaN, cannot be expressed as a date in Excel. ig.ArgumentException comparisonOperator is BeginsWith, DoesNotBeginWith, EndsWith, DoesNotEndWith, Contains, or DoesNotContain. Remarks
Note: If the value is 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 will be missing from the column.
For numbers, the comparisonOperator cannot be BeginsWith, DoesNotBeginWith, EndsWith, DoesNotEndWith, Contains, or DoesNotContain.
For dates, the comparisonOperator cannot be BeginsWith, DoesNotBeginWith, EndsWith, DoesNotEndWith, Contains, or DoesNotContain.
See Also
-
comparisonOperator
- .comparisonOperator( );
- Return Type:
- ig.excel.ExcelComparisonOperator
- Return Type Description:
- Returns a ExcelComparisonOperator.
Gets the operator which describes how the cell values should be compared against CustomFilterCondition.value.
-
equals
- .equals( obj:object );
- Return Type:
- boolean
- Return Type Description:
- True if the object is equal to this instance; False otherwise.
Determines whether the CustomFilterCondition is equal to the specified object.
- obj
- Type:object
- The object to test for equality.
-
getHashCode
- .getHashCode( );
- Return Type:
- number
- Return Type Description:
- A number which can be used to hash this instance.
Gets the hash code for the CustomFilterCondition.
-
value
- .value( );
Gets the value against which the cell values should be compared.