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.v20.1.Core.dll

Declaration

[DefaultValue(DefaultBoolean.Default)]
public DefaultBoolean AllowSortBySummary { get; set; }
<DefaultValue(DefaultBoolean.Default)>
Public Property AllowSortBySummary As DefaultBoolean

Property Value

Type Default Description
DefaultBoolean

Default

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

Property Paths

You can access this nested property as listed below:

Show 11 property paths
Library Object Type Path to AllowSortBySummary
Cross-Platform Class Library PivotGridFieldBase
.Options.AllowSortBySummary
WinForms Controls PivotGridField
.Options.AllowSortBySummary
PivotGridField
.Options.AllowSortBySummary
ASP.NET Controls and MVC Extensions PivotGridField
.Options.AllowSortBySummary
PivotGridField
.Options.AllowSortBySummary
MVCxPivotGridField
.Options.AllowSortBySummary
MVCxPivotGridField
.Options.AllowSortBySummary
Reporting XRPivotGridField
.Options.AllowSortBySummary
XRPivotGridField
.Options.AllowSortBySummary
XRPivotGridField
.Options.AllowSortBySummary
XRPivotGridField
.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.

SortBySummaryMenu

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:

SortBySummaryMenu_res

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.

See Also