GrapeCity.Spreadsheet.Commands.PivotTables.PivotTableCommand.Filter

Filter Method

Filter(IPivotTable, int, IndexBitmap)

Initializes a new command to filter the IPivotTable by a specific IPivotField.

Declaration

public static Command Filter(IPivotTable pivotTable, int pivotFieldIndex, IndexBitmap visibleItemsList)

Public Shared Function Filter(pivotTable As IPivotTable, pivotFieldIndex As Integer, visibleItemsList As IndexBitmap) As Command

Parameters

Type	Name	Description
IPivotTable	pivotTable	The IPivotTable object.
int	pivotFieldIndex	The index of IPivotField
IndexBitmap	visibleItemsList	The array of the visible indexes.

Returns

Type	Description
Command	A filter command.

Filter(IPivotTable, int, PivotFilterType, object, object, int, bool)

Initializes a new command to filter the IPivotTable by a specific IPivotField with specified criteria.

Declaration

public static Command Filter(IPivotTable pivotTable, int pivotFieldIndex, PivotFilterType type, object criteria1 = null, object criteria2 = null, int dataFieldPosition = -1, bool wholeDays = false)

Public Shared Function Filter(pivotTable As IPivotTable, pivotFieldIndex As Integer, type As PivotFilterType, Optional criteria1 As Object = Nothing, Optional criteria2 As Object = Nothing, Optional dataFieldPosition As Integer = -1, Optional wholeDays As Boolean = False) As Command

Parameters

Type	Name	Description
IPivotTable	pivotTable	The IPivotTable object.
int	pivotFieldIndex	The index of IPivotField
PivotFilterType	type	The type of filter in a PivotTable
object	criteria1	filter value 1.
object	criteria2	filter value 2.
int	dataFieldPosition	The field to which the filter is attached.
bool	wholeDays

Returns

Type	Description
Command	A filter command.