PivotGridOptionsCustomization.AllowSortBySummary Property

Gets or sets whether end-users can sort row field values by column values, and column field values by row values.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

[DefaultValue(true)]
[XtraSerializableProperty]
public bool AllowSortBySummary { get; set; }

VB.NET

<DefaultValue(True)>
<XtraSerializableProperty>
Public Property AllowSortBySummary As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true if end-users can sort field values by other field values; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to AllowSortBySummary
WinForms Controls	PivotGridControl	.OptionsCustomization.AllowSortBySummary
Reporting	XRPivotGrid	.OptionsCustomization.AllowSortBySummary
ASP.NET Web Forms Controls	ASPxPivotGrid	.OptionsCustomization.AllowSortBySummary
	MVCxPivotGrid	.OptionsCustomization.AllowSortBySummary
	PivotGridSettings	.OptionsCustomization.AllowSortBySummary

Remarks

If the AllowSortBySummary property is set to Default or True, end-users can sort values of row fields or column fields by other columns/rows via a context menu. The context menu is available 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:

To prevent values of an individual column/row field from being sorted by values of rows/columns, set this field’s PivotGridFieldOptions.AllowSortBySummary property to false.