Skip to main content
A newer version of this page is available. .

PivotGroupFilterValue Class

Represents a group filter value.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

public class PivotGroupFilterValue :
    PivotFilterValue,
    IPivotGroupFilterValueParent

Remarks

Group filter values are used to define which of the records in the data source should be displayed and used to calculate summaries within the PivotGrid control. Each group filter value corresponds to a field value from one of the group fields. If the corresponding field is not the last in the group, the filter value owns a collection of child filter values (the PivotGroupFilterValue.ChildValues collection) that represent values from the next field. To learn more, see Group Filter.

The PivotGroupFilterValue objects are stored within the PivotGroupFilterValuesCollection collections. These collections are owned by individual group filter values (PivotGroupFilterValue.ChildValues) and field groups (PivotGridGroup.FilterValues).

The field value that corresponds to the current filter value is obtained via the Value property. To obtain the field to which the filter value belongs, use the PivotGroupFilterValue.Field property.

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

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.

Inheritance

Object
DevExpress.XtraPivotGrid.PivotFilterValue
PivotGroupFilterValue
See Also