PivotGroupFilterValuesCollection.Add(Object) Method

Creates a filter value that corresponds to the specified field value, and adds it to the collection.

Namespace: DevExpress.XtraPivotGrid

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

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

Declaration

C#

public PivotGroupFilterValue Add(
    object value
)

VB.NET

Public Function Add(
    value As Object
) As PivotGroupFilterValue

Parameters

Name	Type	Description
value	Object	The field value for which the filter value should be created and added to the collection.

Returns

Type	Description
PivotGroupFilterValue	A PivotGroupFilterValue object representing the filter value that has been 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(Object) 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#L31

// Then creates a child value of the filter value and adds it to the parent value collection.
OrderDateGroup.FilterValues.Values.Add(2015).ChildValues.Add(1);

VB.NET

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

' Then creates a child value of the filter value and adds it to the parent value collection.
OrderDateGroup.FilterValues.Values.Add(2015).ChildValues.Add(1)