PivotGridFieldSortCondition Class

Represents a sort condition used to identify the column/row by whose values the other field values will be sorted.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

public class PivotGridFieldSortCondition

VB.NET

Public Class PivotGridFieldSortCondition

Related API Members

The following members accept/return PivotGridFieldSortCondition objects:

• PivotGridFieldSortConditionCollection.Item[PivotGridFieldBase]

Remarks

To identify the column/row by whose values their values will be sorted, pivot grid fields hold the PivotGridFieldSortBySummaryInfo.Conditions collection, which contains the PivotGridFieldSortCondition objects (the PivotGridFieldSortBySummaryInfo object is accessed via the PivotGridFieldBase.SortBySummaryInfo property).

A sort condition represents a field value. The PivotGridFieldSortBySummaryInfo.Conditions collection contains one sort condition for each field in the current Header Area. Together, these conditions identify the required column/row. For instance, the highlighted column on the image below is identified by three sort conditions.

The field value which the sort condition represents is specified by the PivotGridFieldSortCondition.Value property. The field to which the value belongs is specified by the PivotGridFieldSortCondition.Field property.

If the pivot grid is bound to an OLAP data source, the field value is identified by the corresponding OLAP member’s unique name (PivotGridFieldSortCondition.OLAPUniqueMemberName). In this instance, the PivotGridFieldSortCondition.Value property is set to null.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PivotGridFieldSortCondition 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-a-custom-sort-by-summary-feature-e2917/CS/WindowsApplication53/Form1.cs#L102

private void SetFieldSortBySummary(PivotFieldItemBase field, PivotFieldItemBase dataField, List<PivotGridFieldSortCondition> condition, bool sort)
{

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

bool IsValueFit(FieldValue value, List<PivotGridFieldSortCondition> conds, PivotGridFieldBase field) {
    for(int i = 0; i < conds.Count; i++) {

how-to-implement-sorting-by-summary-in-olap-mode-e3092/CS/ASPxPivotGrid_OLAPSortBySummary/Default.aspx.cs#L35

fieldMonth.SortBySummaryInfo.Conditions.Add(
    new PivotGridFieldSortCondition(fieldCountry, "Australia", countryMember.UniqueName));
fieldMonth.SortBySummaryInfo.Conditions.Add(

how-to-sort-data-by-a-particular-column-or-row-e3091/CS/ASPxPivotGrid_SortBySummary/Default.aspx.cs#L16

fieldProductName.SortBySummaryInfo.Conditions.Add(
    new PivotGridFieldSortCondition(fieldOrderYear, "1994"));
fieldProductName.SortBySummaryInfo.Conditions.Add(

how-to-sort-a-xtrapivotgrid-by-clicking-on-a-field-value-e1434/CS/Form1.cs#L41

for(int j = 0; j < higherFields.Length; j++) {
    otherFields[i].SortBySummaryInfo.Conditions.Add(new PivotGridFieldSortCondition(higherFields[j], higherValues[j]));
}

VB.NET

how-to-implement-a-custom-sort-by-summary-feature-e2917/VB/WindowsApplication53/Form1.vb#L99

Private Sub SetFieldSortBySummary(ByVal field As PivotFieldItemBase, ByVal dataField As PivotFieldItemBase, ByVal condition As List(Of PivotGridFieldSortCondition), ByVal sort As Boolean)
    If Not field.CanSortBySummary Then

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

Private Function IsValueFit(ByVal value As FieldValue, ByVal conds As List(Of PivotGridFieldSortCondition), ByVal field As PivotGridFieldBase) As Boolean
    For i As Integer = 0 To conds.Count - 1

how-to-implement-sorting-by-summary-in-olap-mode-e3092/VB/ASPxPivotGrid_OLAPSortBySummary/Default.aspx.vb#L40

fieldMonth.SortBySummaryInfo.Conditions.Clear()
fieldMonth.SortBySummaryInfo.Conditions.Add(New PivotGridFieldSortCondition(fieldCountry, _
                                                     "Australia", countryMember.UniqueName))

how-to-sort-data-by-a-particular-column-or-row-e3091/VB/ASPxPivotGrid_SortBySummary/Default.aspx.vb#L18

fieldProductName.SortBySummaryInfo.Conditions.Add( _
    New PivotGridFieldSortCondition(fieldOrderYear, "1994"))
fieldProductName.SortBySummaryInfo.Conditions.Add( _

how-to-sort-a-xtrapivotgrid-by-clicking-on-a-field-value-e1434/VB/Form1.vb#L45

For j As Integer = 0 To higherFields.Length - 1
    otherFields(i).SortBySummaryInfo.Conditions.Add(New PivotGridFieldSortCondition(higherFields(j), higherValues(j)))
Next j

Inheritance

Object

PivotGridFieldSortCondition