FarPoint.Web.Spread.IRowFilter

IRowFilter Interface

Interface that supports row filters for filtering rows on a sheet.

Namespace: FarPoint.Web.Spread

Assembly: FarPoint.Web.Spread.dll

Syntax

public interface IRowFilter : ISerializeSupport

Public Interface IRowFilter
    Inherits ISerializeSupport

Properties

Name	Description
AllString	Gets or sets the "(All)" filter item string.
BlanksString	Gets or sets the "(Blanks)" filter item string.
ColumnDefinitions	Gets the collection of filter column definitions for the sheet.
NonBlanksString	Gets or sets the "(NonBlanks)" filter item string.
SheetView	Gets or sets the sheet for this row filter.
ShowFilterIndicator	Gets or sets whether the filter indicator is displayed.
UnfilteredRows	Gets or sets rows that are not to be filtered.

Methods

Name	Description
AddColumn(FilterColumnDefinition)	Adds a filter column definition to the row filter.
AddColumn(int)	Adds a filter column definition to the row filter.
AddColumn(int, FilterListBehavior)	Adds a filter column definition to the row filter.
AddFilteredOutRow(int)	Adds a row to the filtered-out row list, which is the list of rows currently filtered-out by the combined settings of the filtered columns.
GetColumnFilterBy(int)	Gets the string selected in the drop-down list of filters for the specified column.
GetColumnFilterIndexFromColumnIndex(int)	Gets the column filter index for the specified column.
GetFilterColumnDefinition(int)	Gets the filter column definition for the specified column.
GetFilteredColumnIndexes()	Gets an array of column indexes where row filters exist.
GetFilteredOutRowList()	Gets the list of rows that are filtered out.
GetIntersectedFilteredInRows()	Gets the intersection of the filtered-in rows for all the filtered columns.
GetIntersectedFilteredInRows(int)	Gets the intersection of the filtered-in rows for all the filtered columns except the specified column.
IsFiltered(int)	Determines whether the specified column is filtered.
IsRowFilteredOut(int)	Determines whether the specified row is filtered out.
MoveFilters(int, int, int, int, int, int)	Moves the filter column(s) to another location.
RemoveColumn(int)	Removes a filter column definition from the row filter.
ResetFilter()	Resets the temporary filter settings for all columns.
ResetFilter(int)	Resets the temporary filter settings for the specified column.
SetColumnFilterBy(int, string)	Internal use only. Sets the string selected in the drop-down list of filters for the specified column.
SetIsFiltered(int, bool)	Internal use only. Sets the isFiltered flag for the existing column filter.
SetupEventHandlers()	Sets up the event handlers to listen to the SheetView object. Intended for internal use only.