[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Collapse]Cross-Platform Core Libraries
  Core Library Assemblies
 [Expand]DevExpress Data Library
 [Expand]DevExpress Pivot Grid Core Library
 [Expand]Miscellaneous
 [Collapse]API Reference
  [Expand]DevExpress.Data
  [Expand]DevExpress.Data.Browsing
  [Expand]DevExpress.Data.Browsing.Design
  [Expand]DevExpress.Data.Camera
  [Expand]DevExpress.Data.Controls
  [Expand]DevExpress.Data.Controls.ExpressionEditor
  [Expand]DevExpress.Data.Entity
  [Expand]DevExpress.Data.Filtering
  [Expand]DevExpress.Data.Filtering.Exceptions
  [Expand]DevExpress.Data.Filtering.Helpers
  [Expand]DevExpress.Data.Linq
  [Expand]DevExpress.Data.ODataLinq
  [Expand]DevExpress.Data.PivotGrid
  [Expand]DevExpress.Data.PLinq
  [Expand]DevExpress.Data.TreeList
  [Expand]DevExpress.Data.Utils
  [Expand]DevExpress.Data.Utils.ServiceModel
  [Expand]DevExpress.Data.WcfLinq
  [Expand]DevExpress.Data.WizardFramework
  [Expand]DevExpress.Data.XtraReports.DataProviders
  [Expand]DevExpress.Data.XtraReports.Labels
  [Expand]DevExpress.Data.XtraReports.ServiceModel
  [Expand]DevExpress.Data.XtraReports.ServiceModel.DataContracts
  [Expand]DevExpress.Data.XtraReports.Wizard
  [Expand]DevExpress.Data.XtraReports.Wizard.Presenters
  [Expand]DevExpress.Data.XtraReports.Wizard.Views
  [Expand]DevExpress.DataAccess
  [Expand]DevExpress.DataAccess.ConnectionParameters
  [Expand]DevExpress.DataAccess.DataFederation
  [Expand]DevExpress.DataAccess.EntityFramework
  [Expand]DevExpress.DataAccess.Excel
  [Expand]DevExpress.DataAccess.ExpressionEditor
  [Expand]DevExpress.DataAccess.Json
  [Expand]DevExpress.DataAccess.Localization
  [Expand]DevExpress.DataAccess.ObjectBinding
  [Expand]DevExpress.DataAccess.Sql
  [Expand]DevExpress.DataAccess.Sql.DataApi
  [Expand]DevExpress.DataAccess.UI
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DataAccess.Web
  [Expand]DevExpress.DataAccess.Wizard
  [Expand]DevExpress.DataAccess.Wizard.Model
  [Expand]DevExpress.DataAccess.Wizard.Presenters
  [Expand]DevExpress.DataAccess.Wizard.Services
  [Expand]DevExpress.DataAccess.Wizard.Views
  [Expand]DevExpress.Diagram.Core
  [Expand]DevExpress.Diagram.Core.Layout
  [Expand]DevExpress.Diagram.Core.Localization
  [Expand]DevExpress.Diagram.Core.Shapes
  [Expand]DevExpress.Diagram.Core.Themes
  [Expand]DevExpress.DocumentServices.ServiceModel
  [Expand]DevExpress.DocumentServices.ServiceModel.Client
  [Expand]DevExpress.DocumentServices.ServiceModel.DataContracts
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.Entity.Model
  [Expand]DevExpress.Entity.ProjectModel
  [Expand]DevExpress.Export
  [Expand]DevExpress.Export.Xl
  [Expand]DevExpress.Map
  [Expand]DevExpress.Mvvm
  [Expand]DevExpress.Mvvm.DataAnnotations
  [Expand]DevExpress.Mvvm.DataModel
  [Expand]DevExpress.Mvvm.Gantt
  [Expand]DevExpress.Mvvm.ModuleInjection
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.Utils
  [Expand]DevExpress.Mvvm.ViewModel
  [Expand]DevExpress.Office.Crypto
  [Expand]DevExpress.PivotGrid.DataBinding
  [Expand]DevExpress.PivotGrid.Printing
  [Expand]DevExpress.Printing
  [Expand]DevExpress.Printing.Core
  [Expand]DevExpress.Printing.ExportHelpers
  [Expand]DevExpress.ReportServer.Printing
  [Expand]DevExpress.ReportServer.Printing.Services
  [Expand]DevExpress.ReportServer.ServiceModel.Client
  [Expand]DevExpress.ReportServer.ServiceModel.ConnectionProviders
  [Expand]DevExpress.ReportServer.ServiceModel.DataContracts
  [Expand]DevExpress.Schedule
  [Expand]DevExpress.Security.Resources
  [Expand]DevExpress.Services
  [Expand]DevExpress.Sparkline
  [Expand]DevExpress.TreeMap
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Commands
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Filtering
  [Expand]DevExpress.Utils.Filtering.Internal
  [Expand]DevExpress.Utils.IoC
  [Expand]DevExpress.Utils.Localization
  [Expand]DevExpress.Utils.Serializing.Helpers
  [Expand]DevExpress.Utils.Svg
  [Expand]DevExpress.WebUtils
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpo
  [Expand]DevExpress.Xpo.DB
  [Expand]DevExpress.Xpo.DB.Exceptions
  [Expand]DevExpress.Xpo.DB.Helpers
  [Expand]DevExpress.Xpo.Helpers
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Localization
  [Expand]DevExpress.XtraCharts.Native
  [Expand]DevExpress.XtraCharts.Printing
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraExport.Csv
  [Expand]DevExpress.XtraGauges.Base
  [Expand]DevExpress.XtraGauges.Core
  [Expand]DevExpress.XtraGauges.Core.Base
  [Expand]DevExpress.XtraGauges.Core.Drawing
  [Expand]DevExpress.XtraGauges.Core.Localization
  [Expand]DevExpress.XtraGauges.Core.Model
  [Expand]DevExpress.XtraGauges.Core.Primitive
  [Expand]DevExpress.XtraGrid
  [Collapse]DevExpress.XtraPivotGrid
    AdomdVersion Enumeration
    AllowHideFieldsType Enumeration
    AsyncCompletedHandler Delegate
   [Expand]AsyncOperationResult Class
   [Expand]BaseFilter Class
    CalculationDirection Enumeration
    CalculationPartitioningCriteria Enumeration
    CopyCollapsedValuesMode Enumeration
    CopyMultiSelectionMode Enumeration
   [Expand]CrossAreaKey Class
   [Expand]CustomCustomizationFormSortEventArgsBase<T> Class
   [Expand]CustomFieldDataEventArgsBase<T> Class
   [Expand]CustomServerModeSortEventArgsBase<T> Class
   [Expand]DataBindingBase Class
    DataFieldUnboundExpressionMode Enumeration
    DifferenceTarget Enumeration
    DifferenceType Enumeration
    ExportCellType Enumeration
   [Expand]FieldValueCellBase<T> Class
   [Expand]IOLAPMember Interface
   [Expand]IPivotCustomSummaryValue Interface
   [Expand]IThreadSafeAccessible Interface
   [Expand]IThreadSafeField Interface
   [Expand]IThreadSafeFieldCollection Interface
   [Expand]IThreadSafeGroup Interface
   [Expand]IThreadSafeGroupCollection Interface
    OLAPDataProvider Enumeration
    PivotArea Enumeration
   [Expand]PivotCellEventArgsBase<TField, TData, TCustomTotal> Class
    PivotChartDataProvideMode Enumeration
    PivotChartDataProvidePriority Enumeration
   [Expand]PivotChartDataSourceRowBase Class
    PivotChartFieldValuesProvideMode Enumeration
    PivotChartItemDataMember Enumeration
    PivotChartItemType Enumeration
   [Expand]PivotCustomFieldValueCellsEventArgsBase<T1, T2> Class
   [Expand]PivotCustomGroupIntervalEventArgsBase<T> Class
    PivotDataArea Enumeration
    PivotDataProcessingEngine Enumeration
   [Expand]PivotDataSource Class
    PivotDefaultMemberFields Enumeration
   [Expand]PivotDrillDownDataRow Class
   [Expand]PivotDrillDownDataSource Class
    PivotExportArea Enumeration
   [Expand]PivotFieldDisplayTextEventArgsBase<T> Class
   [Expand]PivotFieldEventArgsBase<T> Class
    PivotFieldPropertyName Enumeration
   [Expand]PivotFieldValueEventArgsBase<T> Class
   [Expand]PivotFilterBase Class
    PivotFilterType Enumeration
   [Expand]PivotGridAdomdDataSource Class
    PivotGridAllowedAreas Enumeration
    PivotGridBestFitMode Enumeration
   [Expand]PivotGridCustomFieldSortEventArgsBase<T> Class
   [Expand]PivotGridCustomTotalBase Class
   [Expand]PivotGridCustomTotalCollectionBase Class
   [Expand]PivotGridFieldBase Class
   [Expand]PivotGridFieldCollectionBase Class
   [Expand]PivotGridFieldFilterValues Class
   [Expand]PivotGridFieldOptions Class
   [Expand]PivotGridFieldSortBySummaryInfo Class
   [Expand]PivotGridFieldSortCondition Class
   [Expand]PivotGridFieldSortConditionCollection Class
   [Expand]PivotGridGroup Class
   [Expand]PivotGridGroupCollection Class
   [Expand]PivotGridOptionsBase Class
   [Expand]PivotGridOptionsBehaviorBase Class
   [Expand]PivotGridOptionsChartDataSource Class
   [Expand]PivotGridOptionsCustomization Class
   [Expand]PivotGridOptionsData Class
   [Expand]PivotGridOptionsDataField Class
   [Expand]PivotGridOptionsFilterBase Class
   [Expand]PivotGridOptionsLayout Class
   [Expand]PivotGridOptionsOLAP Class
   [Expand]PivotGridOptionsPrint Class
   [Expand]PivotGridOptionsSelection Class
   [Expand]PivotGridOptionsViewBase Class
   [Expand]PivotGridPageSettings Class
    PivotGridResetOptions Enumeration
    PivotGridValueType Enumeration
   [Expand]PivotGridXmlaDataSource Class
    PivotGroupFilterMode Enumeration
   [Expand]PivotGroupFilterValue Class
   [Expand]PivotGroupFilterValues Class
   [Expand]PivotGroupFilterValuesCollection Class
    PivotGroupInterval Enumeration
    PivotKPIGraphic Enumeration
    PivotKPIType Enumeration
    PivotOLAPFilterUsingWhereClause Enumeration
   [Expand]PivotOLAPKPIMeasures Class
   [Expand]PivotOLAPKPIValue Class
   [Expand]PivotOptionsChangedEventArgs Class
    PivotOptionsChangedEventHandler Delegate
   [Expand]PivotOptionsFilterEventArgs Class
    PivotOptionsFilterEventHandler Delegate
    PivotRowTotalsLocation Enumeration
    PivotSortBySummaryOrder Enumeration
    PivotSortLocation Enumeration
    PivotSortMode Enumeration
    PivotSortOrder Enumeration
   [Expand]PivotSummaryDataRow Class
   [Expand]PivotSummaryDataSource Class
   [Collapse]PivotSummaryFilter Class
     PivotSummaryFilter Members
    [Collapse]PivotSummaryFilter Properties
      ColumnField Property
      ColumnFieldComponentName Property
      EndValue Property
      IsEmpty Property
      Mode Property
      RowField Property
      RowFieldComponentName Property
      StartValue Property
      Validity Property
    [Expand]PivotSummaryFilter Methods
    PivotSummaryFilterMode Enumeration
    PivotSummaryFilterValidity Enumeration
   [Expand]PivotSummaryInterval Class
    PivotTopValueType Enumeration
    PivotTotalsLocation Enumeration
    PivotTotalsVisibility Enumeration
   [Expand]PivotXlsExportOptionsBase Class
   [Expand]PivotXlsxExportOptionsBase Class
   [Expand]PrefilterBase Class
    RankType Enumeration
    TopValueMode Enumeration
    UnboundExpressionMode Enumeration
  [Expand]DevExpress.XtraPivotGrid.Customization
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPivotGrid.Localization
  [Expand]DevExpress.XtraPivotGrid.Selection
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.BarCode
  [Expand]DevExpress.XtraPrinting.Caching
  [Expand]DevExpress.XtraPrinting.DataNodes
  [Expand]DevExpress.XtraPrinting.Drawing
  [Expand]DevExpress.XtraPrinting.Export
  [Expand]DevExpress.XtraPrinting.Export.Web
  [Expand]DevExpress.XtraPrinting.Localization
  [Expand]DevExpress.XtraPrinting.Native
  [Expand]DevExpress.XtraPrinting.Shape
  [Expand]DevExpress.XtraPrinting.Shape.Native
  [Expand]DevExpress.XtraPrinting.WebClientUIControl.DataContracts
  [Expand]DevExpress.XtraPrinting.XamlExport
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports
  [Expand]DevExpress.XtraReports.Design
  [Expand]DevExpress.XtraReports.Expressions
  [Expand]DevExpress.XtraReports.Parameters
  [Expand]DevExpress.XtraReports.ReportGeneration
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Compatibility
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Exchange
  [Expand]DevExpress.XtraScheduler.iCalendar
  [Expand]DevExpress.XtraScheduler.iCalendar.Components
  [Expand]DevExpress.XtraScheduler.Localization
  [Expand]DevExpress.XtraScheduler.Native
  [Expand]DevExpress.XtraScheduler.Outlook
  [Expand]DevExpress.XtraScheduler.Outlook.Interop
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.Tools
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraScheduler.Xml
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Rules
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

PivotSummaryFilter.ColumnField Property

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

Namespace:DevExpress.XtraPivotGrid
Assembly:DevExpress.PivotGrid.v19.2.Core.dll

Expanded Syntax

Property value

Type: PivotGridFieldBase
A PivotGridFieldBase descendant that specifies a column field used to identify an aggregation level to which the filtering is applied.
The default is null.

Expanded 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 aggregation 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 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 Mode property to PivotSummaryFilterMode.SpecificLevel.

For more information about aggregation levels, see Aggregation Levels.

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

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

If the Mode property is set to PivotSummaryFilterMode.LastLevel, summary filtering is applied to cells that belong to the last level and the ColumnField and 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 Apply method and pass these settings as parameters.

To learn more, see Filtering by Summaries Overview and Using Summary Filters.

Expanded See Also

Is this topic helpful?​​​​​​​