PivotGridFieldBase.FilterValues Property

Gets or sets filter values for the current field.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v17.2.Core.dll

Declaration

C#

[XtraSerializableProperty(XtraSerializationVisibility.Content, XtraSerializationFlags.DefaultValue)]
[Browsable(false)]
public PivotGridFieldFilterValues FilterValues { get; set; }

VB.NET

<Browsable(False)>
<XtraSerializableProperty(XtraSerializationVisibility.Content, XtraSerializationFlags.DefaultValue)>
Public Property FilterValues As PivotGridFieldFilterValues

Property Value

Type	Description
PivotGridFieldFilterValues	A PivotGridFieldFilterValues object that contains filter values for the current field.

Remarks

Use the FilterValues property to specify which records in the datasource should be displayed and used to calculate summaries within the PivotGridControl.

The PivotGridFieldFilterValues.Values property defines an array of filter values.

If the PivotGridFieldFilterValues.FilterType property is set to PivotFilterType.Excluded, datasource records that contain filter values in the current field are not processed by PivotGridControl.

If the PivotGridFieldFilterValues.FilterType property is set to PivotFilterType.Included, only records that contain filter values in the current field are processed.

An end-user automatically modifies the filter values collection when checking/unchecking specific items via the field’s filter drop-down.

The FilterValues property allows you to configure filtering by field values. In Pivot Grid, you can also filter data by summary values. To configure filtering by summaries, use the PivotGridFieldBase.SummaryFilter property.

Example

The example below shows how to apply filtering to the ‘fieldTradeMark’ field by adding ‘Chevrolet’ or ‘Chrysler’ to the PivotGridFieldBase.FilterValues collection.

C#

pivotGridControl.BeginUpdate();
try {
    fieldTrademark.FilterValues.Clear();
    fieldTrademark.FilterValues.FilterType = PivotFilterType.Included;
    fieldTrademark.FilterValues.Add("Chevrolet");
    fieldTrademark.FilterValues.Add("Chrysler");
}
finally {
    pivotGridControl.EndUpdate();
}

VB.NET

pivotGridControl.BeginUpdate()
Try
    fieldTrademark.FilterValues.Clear()
    fieldTrademark.FilterValues.FilterType = PivotFilterType.Included
    fieldTrademark.FilterValues.Add("Chevrolet")
    fieldTrademark.FilterValues.Add("Chrysler")
Finally
    pivotGridControl.EndUpdate()
End Try

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FilterValues property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/CS/E4669CS/CustomFieldFilterControl.cs#L48

_field.PivotGrid.BeginUpdate();
_field.FilterValues.Clear();
if (_field.FilterValues.FilterType == PivotFilterType.Included)

how-to-apply-a-filter-e1867/CS/ASPxPivotGrid_ApplyFilter/Default.aspx.cs#L13

// Clears the filter value collection and add two items to it.
field.FilterValues.Clear();
field.FilterValues.Add("Brazil");

how-to-obtain-active-filter-criteria-applied-to-pivotgridcontrols-fields-e1999/CS/WindowsApplication1/MyPivotGridFilterHelper.cs#L31

{
    object[] values = field.FilterValues.Values;
    if (values.Length == 0) return;

how-to-add-custom-interactivity-to-a-dashboard-displayed-in-the-winforms-viewer-t189795/CS/Dashboard_CustomVisualInteractivity/Form1.cs#L33

pivotGridControl1.BeginUpdate();
fieldCategoryName1.FilterValues.FilterType = PivotFilterType.Included;
fieldCategoryName1.FilterValues.Clear();

how-to-sort-data-in-server-mode-using-the-customservermodesort-event-t264145/CS/WinFormsPivotGridCustomServerModeSort/Form1.cs#L19

{
    field.FilterValues.Clear();
    field.FilterValues.Add(1996);

VB.NET

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/VB/CustomFieldFilterControl.vb#L45

_field.PivotGrid.BeginUpdate()
_field.FilterValues.Clear()
If _field.FilterValues.FilterType = PivotFilterType.Included Then

how-to-apply-a-filter-e1867/VB/ASPxPivotGrid_ApplyFilter/Default.aspx.vb#L15

' Clears the filter value collection and add two items to it.
field.FilterValues.Clear()
field.FilterValues.Add("Brazil")

how-to-obtain-active-filter-criteria-applied-to-pivotgridcontrols-fields-e1999/VB/WindowsApplication1/MyPivotGridFilterHelper.vb#L28

Private Sub WriteFieldFilter(ByVal field As PivotGridField)
    Dim values() As Object = field.FilterValues.Values
    If values.Length = 0 Then

how-to-add-custom-interactivity-to-a-dashboard-displayed-in-the-winforms-viewer-t189795/VB/Dashboard_CustomVisualInteractivity/Form1.vb#L37

pivotGridControl1.BeginUpdate()
fieldCategoryName1.FilterValues.FilterType = PivotFilterType.Included
fieldCategoryName1.FilterValues.Clear()

how-to-sort-data-in-server-mode-using-the-customservermodesort-event-t264145/VB/WinFormsPivotGridCustomServerModeSort/Form1.vb#L17

Try
    field.FilterValues.Clear()
    field.FilterValues.Add(1996)