PivotGroupFilterValuesCollection.Add(PivotGroupFilterValue) Method

Adds the specified filter value to the collection.

Namespace: DevExpress.XtraPivotGrid

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

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Navigation

Declaration

C#

public void Add(
    PivotGroupFilterValue value
)

VB.NET

Public Sub Add(
    value As PivotGroupFilterValue
)

Parameters

Name	Type	Description
value	PivotGroupFilterValue	A PivotGroupFilterValue object representing the filter value that should be added to the collection.

Remarks

Several filter values cannot correspond to a single field value. If a filter value corresponding to the same field value (with the same DevExpress.XtraPivotGrid.PivotFilterValue.Value) is already contained in the collection, an exception is thrown. To obtain whether a particular field value is already represented in the collection, use the PivotGroupFilterValuesCollection.ContainsValue method.

To remove a filter value from the collection, use the PivotGroupFilterValuesCollection.Remove method.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Add(PivotGroupFilterValue) method.

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#

winforms-pivot-grid-implement-group-filter/CS/GroupFilter/Form1.cs#L27

// Creates a filter value and adds it to the PivotGroupFilterValues.Values collection.
OrderDateGroup.FilterValues.Values.Add(new PivotGroupFilterValue(2014));

VB.NET

winforms-pivot-grid-implement-group-filter/VB/GroupFilter/Form1.vb#L29

' Creates a filter value and adds it to the PivotGroupFilterValues.Values collection.
OrderDateGroup.FilterValues.Values.Add(New PivotGroupFilterValue(2014))