PivotGridControl.CustomServerModeSort Event

In OLAP and server mode, provides the capability to sort data using custom rules.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v22.2.dll

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public event EventHandler<CustomServerModeSortEventArgs> CustomServerModeSort

VB.NET

Public Event CustomServerModeSort As EventHandler(Of CustomServerModeSortEventArgs)

Event Data

The CustomServerModeSort event's data class is CustomServerModeSortEventArgs. The following properties provide information specific to this event:

Property	Description
Field	Gets the field whose values are being compared.
OlapMember1	Get the first member being compared.
OlapMember2	Get the second member being compared.
Result	Gets or sets the result of a custom comparison.
ThreadSafeField
Value1	Gets the first value being compared.
Value2	Gets the second value being compared.

The event data class exposes the following methods:

Method	Description
GetCellValue1(CrossAreaKey, PivotGridField)	In OLAP and server mode, returns the first cell value calculated for the specified cross area key against the specified data field.
GetCellValue1(Object[], PivotGridField)	In OLAP and server mode, returns the first cell value calculated for the specified cross area field values against the specified data field.
GetCellValue2(CrossAreaKey, PivotGridField)	In OLAP and server mode, returns the second cell value calculated for the specified cross area key against the specified data field.
GetCellValue2(Object[], PivotGridField)	In OLAP and server mode, returns the second cell value calculated for the specified cross area field values against the specified data field.
GetCrossAreaKey(Object[])	In OLAP and server mode, returns cross area values by which you want to sort the pivot grid column or row.
SetArgs(IQueryMemberProvider, IQueryMemberProvider, IPivotGridField, PivotGridData, ICustomSortHelper)

Remarks

Note

The PivotGridField.SortMode property of the sorted field should be set to Custom to apply custom sorting. Otherwise, the CustomServerModeSort event will not be raised.

View Example: How to: Sort Data in Server Mode with the Custom Sorting Algorithm

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomServerModeSort event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

how-to-sort-data-in-server-mode-using-the-customservermodesort-event-t264201/CS/WPFPivotGridCustomServerModeSort/MainWindow.xaml#L13

<Grid>
    <dxpg:PivotGridControl Name="pivotGridControl1" DataSource="{Binding Path=Data, Source={StaticResource EntityServerModeDataSource}}" CustomServerModeSort="pivotGridControl1_CustomServerModeSort">
        <dxpg:PivotGridControl.Fields>