Skip to main content

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.v22.2.Core.dll

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Dashboard.Design

Declaration

public PivotGroupFilterValue Add(
    object value
)

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.

The following code snippets (auto-collected from DevExpress Examples) contain references 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.

See Also