PivotGroupFilterValues.FindFilterValue(Object[]) Method

Returns a filter value that corresponds to the specified group value.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v20.1.Core.dll

Declaration

public PivotGroupFilterValue FindFilterValue(
    params object[] values
)
Public Function FindFilterValue(
    ParamArray values As Object()
) As PivotGroupFilterValue

Parameters

Name Type Description
values Object[]

An array of field values that identify the group value.

Returns

Type Description
PivotGroupFilterValue

A PivotGroupFilterValue object, which is a filter value that corresponds to the specified group value; null (Nothing in Visual Basic) if the required filter value has not been found.

Remarks

Consider a field group that contains three fields - Year, Quarter and Month - and whose filter condition is set as shown in the image below:

pivotgrid_GroupFilterMode_GroupFilterDropdown

The following table demonstrates how to use the FindFilterValue method to obtain filter values by the corresponding group values.

Group Value Method Usage
1994 filterValues.FindFilterValue(1994)
Quarter 3 | 1994 filterValues.FindFilterValue(1994, 3)
August | Quarter 3 | 1994 filterValues.FindFilterValue(1994, 3, 8)

To determine whether the current filter condition allows processing a particular group value, use the PivotGroupFilterValues.Contains method.

See Also