PivotGridSettings.CustomFieldSort Property

Provides the ability to sort data using custom rules.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v20.2.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public PivotGridCustomFieldSortEventHandler CustomFieldSort { get; set; }

VB.NET

Public Property CustomFieldSort As PivotGridCustomFieldSortEventHandler

Property Value

Type	Description
PivotGridCustomFieldSortEventHandler	A PivotGridCustomFieldSortEventHandler delegate method allowing you to implement custom processing.

Remarks

Handle the CustomFieldSort event to provide a custom sorting algorithm for a specific field. Note that the PivotGridFieldBase.SortMode property of this field should be set to PivotSortMode.Custom to apply custom sorting. Otherwise, the CustomFieldSort event will not be raised.

The CustomFieldSort event fires for pairs of rows in the underlying data source, before data is grouped according to the layout of column and row fields. The PivotGridCustomFieldSortEventArgs.ListSourceRowIndex1 and PivotGridCustomFieldSortEventArgs.ListSourceRowIndex2 parameters identify the indexes of the rows. The field being processed is specified by the PivotGridCustomFieldSortEventArgs.Field parameter. The field’s values in these rows are specified by the PivotGridCustomFieldSortEventArgs.Value1 and PivotGridCustomFieldSortEventArgs.Value2 parameters.

In the event handler, you should compare these two values and assign the result to the PivotGridCustomFieldSortEventArgs.Result property as follows:

• set Result to -1, if the first row should be positioned above the second row, when sorting data in ascending order. When data is sorted in descending order, the first row will be positioned below the second row.
• set Result to 1, if the first row should be positioned below the second row, when sorting data in ascending order. When data is sorted in descending order, the first row will be positioned above the second row.
• set Result to 0 to indicate that the rows are equal. In this instance, the rows will be arranged according to their indexes in the data source.

If your comparison logic requires additional data from the underlying data source, use the PivotGridCustomFieldSortEventArgs.GetListSourceColumnValue method. This method allows you to obtain values from the data source by a column name and row index.

The PivotGridCustomFieldSortEventArgs.Handled property must be set to true, if the current comparison operation was handled. You can leave this parameter set to false, to invoke the default comparison mechanism after your event handler has finished. In the latter instance, the result of a custom comparison operation is ignored.

The CustomFieldSort event also fires to sort unique filter values in the Filter Window. Each filter value might correspond to multiple rows in the underlying data source. So, the event’s ListSourceRowIndex1 and ListSourceRowIndex2 parameters cannot be used to identify underlying rows. They are set to -1, when comparing filter values in the Filter Window.

Note

Custom sorting is not supported in OLAP or server mode. To sort data in OLAP and server mode using custom algorithms, handle the ASPxPivotGrid.CustomServerModeSort event.

Example

This example demonstrates how to sort a field (Sales_Person) by the hidden data field values (LastName).

Check the Enable Custom Sorting box to sort the Sales_Person values by LastName instead of the default alphabetical sorting order.

The enabled check box switches the PivotGridField.SortModeProperty property to the Custom value. This setting allows the PivotGridControl to fire the CustomFieldSort event for that field using the PivotGridSettings.CustomFieldSort property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/mvc-pivot-grid-custom-field-sort

Index.cshtml

@{
    ViewBag.Title = "Home Page";
}
<script>
    function onCheckedChanged(s, e) {
        PivotGrid.PerformCallback({ enable: s.GetChecked() });
    }
</script>


@Html.DevExpress().CheckBox(settings => {
    settings.Name = "CheckBox";
    settings.Checked = false;
    settings.Text = "Enable Custom Sorting";
    settings.Properties.ClientSideEvents.CheckedChanged = "onCheckedChanged";
}).GetHtml()

@Html.Action("PivotGridPartial")

_PivotGridPartial.cshtml

@Html.DevExpress().PivotGrid(settings => {
    settings.Name = "PivotGrid";
    settings.CallbackRouteValues = new { Controller = "Home", Action = "PivotGridPartial" };
    settings.CustomFieldSort = (sender, e) => {
        if(e.Field.FieldName == "Sales_Person") {
            if(e.SortLocation == PivotSortLocation.Pivot) {
                object orderValue1 = e.GetListSourceColumnValue(e.ListSourceRowIndex1, "LastName"),
                    orderValue2 = e.GetListSourceColumnValue(e.ListSourceRowIndex2, "LastName");
                e.Result = Comparer<object>.Default.Compare(orderValue1, orderValue2);
            } else {
                e.Result = Comparer<object>.Default.Compare(e.Value1.ToString().Split(' ')[1], e.Value2.ToString().Split(' ')[1]);
            }
            e.Handled = true;
        }
    };
    settings.Fields.Add(field => {
        field.Area = PivotArea.RowArea;
        field.AreaIndex = 0;
        field.FieldName = "CategoryName";
        field.Caption = "Category";
    });
    settings.Fields.Add(field => {
        field.Area = PivotArea.RowArea;
        field.AreaIndex = 1;
        field.SortMode = PivotSortMode.Custom;
        field.FieldName = "ProductName";
        field.Caption = "Product";
    });
    settings.Fields.Add(field => {
        field.Area = PivotArea.DataArea;
        field.FieldName = "Extended_Price";
        field.Caption = "Extended Price";
    });
    settings.Fields.Add(field => {
        field.Area = PivotArea.ColumnArea;
        field.FieldName = "Sales_Person";
        field.Caption = "Sales Person";
    });
    settings.Fields.Add(field => {
        field.Area = PivotArea.FilterArea;
        field.FieldName = "Country";
        field.Caption = "Country";
    });
    settings.BeforeGetCallbackResult = (sender, e) => {
        MVCxPivotGrid pivotGrid = sender as MVCxPivotGrid;
        pivotGrid.Fields["Sales_Person"].SortMode = ViewBag.Enable? PivotSortMode.Custom: PivotSortMode.Default;
    };
}).Bind(Model).GetHtml()

HomeController.cs

using System.Linq;
using System.Web.Mvc;

namespace DXWebApplication19.Controllers
{
    public class HomeController : Controller
    {
        public ActionResult Index()
        {
            return View();
        }

        NWindEntities db = new NWindEntities();

        [ValidateInput(false)]
        public ActionResult PivotGridPartial(bool? enable) {
            if(enable != null)
                ViewBag.Enable = enable;
            else
                ViewBag.Enable = false;
            var model = db.SalesPersons;
            return PartialView("_PivotGridPartial", model.ToList());
        }
    }
}