PivotGridFieldBase.SetSortBySummary(PivotGridFieldBase, List<PivotGridFieldSortCondition>, Nullable<PivotSummaryType>, Boolean) Method

Sorts field values by another column's/row's values.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

public void SetSortBySummary(
    PivotGridFieldBase dataField,
    List<PivotGridFieldSortCondition> conditions,
    PivotSummaryType? customTotalSummaryType,
    bool sort
)
Public Sub SetSortBySummary(
    dataField As PivotGridFieldBase,
    conditions As List(Of PivotGridFieldSortCondition),
    customTotalSummaryType As PivotSummaryType?,
    sort As Boolean
)

Parameters

Name Type Description
dataField PivotGridFieldBase

A PivotGridFieldBase descendant that represents the field by whose summary values the current field values are sorted.

conditions List<PivotGridFieldSortCondition>

A list of PivotGridFieldSortCondition objects representing conditions that identify the column or row by whose summary values the current field values are sorted.

customTotalSummaryType Nullable<PivotSummaryType>

A PivotSummaryType object representing the summary type of custom total values by which the field values are sorted. Null if the field values are not sorted by a custom total column/row.

sort Boolean

true to apply the specified sorting by summary, false to remove the current sorting by summary.

Remarks

If the sort parameter is set to false, the SetSortBySummary method removes the current sorting. In this instance, other parameters are ignored.

See Also