PivotSummaryFilter.ColumnField Property

Gets or sets a column field used to identify a detail level to which the filtering is applied.

Namespace: DevExpress.XtraPivotGrid

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

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

Declaration

C#

[DefaultValue(null)]
public PivotGridFieldBase ColumnField { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property ColumnField As PivotGridFieldBase

Property Value

Type	Default	Description
PivotGridFieldBase	null	A PivotGridFieldBase descendant that specifies a column field used to identify a detail levelto which the filtering is applied.

Remarks

Summary filtering cannot be simultaneously enabled for Totals, Grand Totals and data cells calculated against the same data field. It can only be applied to cells that belong to the same detail level.

By default, summary filtering is applied to cells that belong to the last level (a level identified by the last column and row fields). You can use the ColumnField and PivotSummaryFilter.RowField properties to specify other levels instead, except for the (Grand Total, Grand Total) level that consists of only one cell. To enable filtering at a specified level, you should also set the PivotSummaryFilter.Mode property to PivotSummaryFilterMode.SpecificLevel.

For more information about detail levels, see detail levels.

Assign the null (Nothing in Visual Basic) value to the ColumnField property to identify the Grand Total column.

Use the PivotSummaryFilter.RowField property to specify a row field that identifies the detail level.

If the PivotSummaryFilter.Mode property is set to PivotSummaryFilterMode.LastLevel, summary filtering is applied to cells that belong to the last level and the ColumnField and PivotSummaryFilter.RowField properties are not in effect.

As an alternative to specifying summary filter settings using properties exposed by the PivotSummaryFilter object, you can call an appropriate overload of the PivotSummaryFilter.Apply method and pass these settings as parameters.

See Filtering by Summaries for more information.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ColumnField property.

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-apply-summary-filter/CS/XtraPivotGrid_ApplySummaryFilter/Form1.cs#L29

    // Set the row that identifies the filtered aggregation level.
    fieldExtendedPrice1.SummaryFilter.ColumnField = fieldCountry1;
}

VB.NET

winforms-pivot-apply-summary-filter/VB/XtraPivotGrid_ApplySummaryFilter/Form1.vb#L31

    ' Set the row that identifies the filtered aggregation level.
    fieldExtendedPrice1.SummaryFilter.ColumnField = fieldCountry1
Finally