PivotGridCustomFieldSortEventArgs Class

Provides data for the PivotGridControl.CustomFieldSort event.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v18.1.dll

Declaration

C#

public class PivotGridCustomFieldSortEventArgs :
    PivotGridCustomFieldSortEventArgsBase<PivotGridField>

VB.NET

Public Class PivotGridCustomFieldSortEventArgs
    Inherits PivotGridCustomFieldSortEventArgsBase(Of PivotGridField)

Related API Members

PivotGridCustomFieldSortEventArgs is the data class for the following events:

• PivotGridControl.CustomFieldSort

Remarks

If the field’s PivotGridFieldBase.SortMode property is set to PivotSortMode.Custom, its values can be sorted using custom algorithms. To implement custom sorting logic, handle the PivotGridControl.CustomFieldSort event. Data for this event is supplied by the PivotGridCustomFieldSortEventArgs class.

For more information, see PivotGridControl.CustomFieldSort.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PivotGridCustomFieldSortEventArgs class.

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.

C#

how-to-implement-sorting-for-a-custom-cell-value-e2149/CS/ImplementSortingforaCustomCellValue/Form1.cs#L59

private void pivotGridControl1_CustomFieldSort(object sender, PivotGridCustomFieldSortEventArgs e) {
    if(this.pivotData == null || sortInfo == null) {

how-to-reorder-pivotgrid-rows-and-columns-by-drag-and-drop-e4545/CS/ReorderHelper.cs#L144

}
private void targetPivot_CustomFieldSort(object sender, DevExpress.XtraPivotGrid.PivotGridCustomFieldSortEventArgs e)
{

customfieldsort-how-to-sort-field-values-by-invisible-data-column-values-e331/CS/CustomFieldSortExample/Form1.cs#L22

}
void pivotGridControl1_CustomFieldSort(object sender, PivotGridCustomFieldSortEventArgs e) {
    if (e.Field.FieldName == "Sales Person") {

using-customfilterpopupitems-event-to-apply-custom-sort-order-to-filter-popup-items-e3247/CS/WindowsApplication1/Form1.cs#L57

private void pivotGridControl1_CustomFieldSort(object sender, PivotGridCustomFieldSortEventArgs e) {
    if(!rowField.Equals(e.Field))

VB.NET

how-to-implement-sorting-for-a-custom-cell-value-e2149/VB/ImplementSortingforaCustomCellValue/Form1.vb#L61

Private Sub pivotGridControl1_CustomFieldSort(ByVal sender As Object, ByVal e As PivotGridCustomFieldSortEventArgs) Handles pivotGridControl1.CustomFieldSort
    If Me.pivotData Is Nothing OrElse sortInfo Is Nothing Then

how-to-reorder-pivotgrid-rows-and-columns-by-drag-and-drop-e4545/VB/ReorderHelper.vb#L151

End Sub
Private Sub targetPivot_CustomFieldSort(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PivotGridCustomFieldSortEventArgs)
    If AllowDragRow AndAlso e.Field.Area = PivotArea.RowArea Then

customfieldsort-how-to-sort-field-values-by-invisible-data-column-values-e331/VB/CustomFieldSortExample/Form1.vb#L23

End Sub
Private Sub pivotGridControl1_CustomFieldSort(ByVal sender As Object, ByVal e As PivotGridCustomFieldSortEventArgs)
    If e.Field.FieldName = "Sales Person" Then

using-customfilterpopupitems-event-to-apply-custom-sort-order-to-filter-popup-items-e3247/VB/WindowsApplication1/Form1.vb#L59

Private Sub pivotGridControl1_CustomFieldSort(ByVal sender As Object, ByVal e As PivotGridCustomFieldSortEventArgs) Handles pivotGridControl1.CustomFieldSort
    If (Not rowField.Equals(e.Field)) Then

Inheritance

Object

EventArgs

PivotGridCustomFieldSortEventArgsBase<PivotGridField>

PivotGridCustomFieldSortEventArgs