PivotGridOptionsBehaviorBase.SortBySummaryDefaultOrder Property

Gets or sets the sort order applied to a field when sorting by summaries is enabled for it.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

[DefaultValue(PivotSortBySummaryOrder.Default)]
[XtraSerializableProperty]
public PivotSortBySummaryOrder SortBySummaryDefaultOrder { get; set; }

VB.NET

<DefaultValue(PivotSortBySummaryOrder.Default)>
<XtraSerializableProperty>
Public Property SortBySummaryDefaultOrder As PivotSortBySummaryOrder

Property Value

Type	Default	Description
PivotSortBySummaryOrder	**Default**	A PivotSortBySummaryOrder enumeration member that specifies the sort order applied to a field when sorting by summaries is enabled for it.

Available values:

Name	Description
Ascending	Field values are sorted in ascending order.
Descending	Field values are sorted in descending order.
Default	The sort order is not changed.

Property Paths

You can access this nested property as listed below:

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

Remarks

The field sort order is specified by the PivotGridFieldBase.SortOrder property. If the SortBySummaryDefaultOrder property is set to PivotSortBySummaryOrder.Default, sorting by summaries does not change the PivotGridFieldBase.SortOrder property value. Otherwise, if the SortBySummaryDefaultOrder property is set to either PivotSortBySummaryOrder.Ascending or PivotSortBySummaryOrder.Descending, the PivotGridFieldBase.SortOrder property will be set to PivotSortOrder.Ascending or PivotSortOrder.Descending (respectively) when sorting by summaries is enabled.

To learn more, see Sorting by Summary.