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.v20.1.Core.dll

Declaration

public PivotGroupFilterValue Add(
    object value
)
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.

See Also