PivotGridFieldOptions.AllowSortBySummary Property

Gets or sets whether end-users can sort the current row/column field values by other column/row summary values.

Namespace: DevExpress.XtraPivotGrid

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

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

Declaration

C#

[XtraSerializableProperty]
public DefaultBoolean AllowSortBySummary { get; set; }

VB.NET

<XtraSerializableProperty>
Public Property AllowSortBySummary As DefaultBoolean

Property Value

Type	Description
DefaultBoolean	A DefaultBoolean value that specifies whether end-users can sort the current row/column field values by other column/row summary values.

Available values:

Name	Description	Return Value
True	The value is true.	0
False	The value is false.	1
Default	The value is specified by a global option or a higher-level object.	2

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowSortBySummary
PivotGridFieldBase	.Options .AllowSortBySummary

Remarks

The AllowSortBySummary property is applied if the current field is a column field or row field. If the AllowSortBySummary property is set to True and the current field is a column field, end-users can sort the current field’s values by summary values in other rows. If the current field is a row field, end-users can sort the current field’s values by summary values in other columns. For end-users, this type of sorting is available via context menus, invoked when right-clicking an innermost column or row header.

In this example, selecting the “Sort ‘Product Name’ by This Column” option sorts values of the Product Name field by values in the clicked column:

If the AllowSortBySummary property is set to Default, the ability to sort the current field’s values by values in other rows/columns is specified by the PivotGridOptionsCustomization.AllowSortBySummary property.

To sort a field’s values by other columns/rows in code, use the PivotGridFieldBase.SortBySummaryInfo property.