Skip to main content

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

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

Declaration

[XtraSerializableProperty]
public PivotSortBySummaryOrder SortBySummaryDefaultOrder { get; set; }

Property Value

Type Description
PivotSortBySummaryOrder

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.

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.

See Also