Namespace EasyXLS

Class ExcelFilter

System.Object

EasyXLS.ExcelFilter

public class ExcelFilter
extends System.Object

This class stores the auto-filter and advanced filter information.

Method Summary

Modifier and Type	Method	Description
System.String	getCopyTo()	Returns the range where the matching rows of the criteria will be copied.
System.String	getCriteriaRange()	Returns the criteria range.
System.String	getListRange()	Returns the list range.
bool	IsAutoFilter()	Returns true if the auto-filter is applied, false otherwise.
void	removeFilter()	Removes the filter.
void	setAdvancedFilter(System.String listRange, System.String criteriaRange, System.String copyTo)	Sets the advanced filter.
void	setAutoFilter(bool isAutoFilter)	Set if the auto-filter is applied.
void	setAutoFilter(System.String listRange)	Sets the list range where the auto-filter is applied. This method is overridden as setAutoFilter_2 in COM+ version of EasyXLS.
void	setCopyTo(System.String copyTo)	Sets the range where the matching rows of the criteria will be copied.
void	setCriteriaRange(System.String criteriaRange)	Sets the criteria range.
void	setListRange(System.String listRange)	Sets the list range.

Methods inherited from class System.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setAutoFilter

public void setAutoFilter(System.String listRange)

Sets the list range where the auto-filter is applied.
This method is overridden as setAutoFilter_2 in COM+ version of EasyXLS.

Parameters:

listRange - the list range. It can be a cell reference or a cell range

See Also:

• setAdvancedFilter(System.String, System.String, System.String)
• getListRange()
• removeFilter()

setAutoFilter

public void setAutoFilter(bool isAutoFilter)

Set if the auto-filter is applied.

Parameters:

isAutoFilter - true if the auto-filter is applied, false otherwise

See Also:

• setAutoFilter(String)
• IsAutoFilter()

IsAutoFilter

public bool IsAutoFilter()

Returns true if the auto-filter is applied, false otherwise.

Returns:

true if the auto-filter is applied, false otherwise

See Also:

• setAutoFilter(System.String)

setAdvancedFilter

public void setAdvancedFilter(System.String listRange,
 System.String criteriaRange,
 System.String copyTo)

Sets the advanced filter.

Parameters:

listRange - the list range. It can be a cell reference or a cell range

criteriaRange - the criteria range. It can be a cell reference or a cell range

copyTo - the range where the matching rows of the criteria will be copied. It can be a cell reference or a cell range.

See Also:

• setAutoFilter(System.String)
• getListRange()
• getCriteriaRange()
• getCopyTo()
• removeFilter()

setListRange

public void setListRange(System.String listRange)

Sets the list range.

Parameters:

listRange - the list range. It can be a cell reference or a cell range

See Also:

• setCriteriaRange(System.String)
• setCopyTo(System.String)
• getListRange()
• removeFilter()

getListRange

public System.String getListRange()

Returns the list range. It can be a cell reference or a cell range.

Returns:

the list range

See Also:

• setListRange(int, int, int, int, bool)
• setAutoFilter(String)
• removeFilter()

setCriteriaRange

public void setCriteriaRange(System.String criteriaRange)

Sets the criteria range.

Parameters:

criteriaRange - the criteria range. It can be a cell reference or a cell range

See Also:

• setListRange(String)
• setCopyTo(String)
• getCriteriaRange()
• removeFilter()

getCriteriaRange

public System.String getCriteriaRange()

Returns the criteria range. It can be a cell reference or a cell range.

Returns:

the criteria range

See Also:

• setCriteriaRange(System.String)
• removeFilter()

setCopyTo

public void setCopyTo(System.String copyTo)

Sets the range where the matching rows of the criteria will be copied.

Parameters:

copyTo - the range where the matching rows of the criteria will be copied. It can be a cell reference or a cell range.

See Also:

• setListRange(String)
• setCriteriaRange(String)
• getCopyTo()
• removeFilter()

getCopyTo

public System.String getCopyTo()

Returns the range where the matching rows of the criteria will be copied. It can be a cell reference or a cell range.

Returns:

the range where the matching rows of the criteria will be copied

See Also:

• setCopyTo(System.String)
• removeFilter()

removeFilter

public void removeFilter()

Removes the filter.

See Also:

• setAutoFilter(System.String)
• setAdvancedFilter(System.String, System.String, System.String)