SortArgs.Result Property

Gets or sets the result of a custom comparison.

Namespace: DevExpress.Mvvm.Xpf

Assembly: DevExpress.Mvvm.v23.2.dll

NuGet Packages: DevExpress.Mvvm, DevExpress.Win.Navigation

Declaration

C#

public int? Result { get; set; }

VB.NET

Public Property Result As Integer?

Property Value

Type	Description
Nullable<Int32>	The result of a custom comparison.

Remarks

To apply custom sort or group operations, compare two rows and assign the result of the comparison to the Result property. The FirstValue and SecondValue parameters identify the values of these rows in the FieldName column.

When you execute a command bound to the GridControl.CustomColumnSortCommand and TreeListView.CustomColumnSortCommand properties, set the result as follows:

• -1 to position the first row above the second row when data is sorted in ascending order. When data is sorted in descending order, the GridControl positions the first row below the second row.

• 1 to position the first row below the second row when data is sorted in ascending order. When data is sorted in descending order, the GridControl positions the first row above the second row.

• 0 to indicate that the rows are equal. In this case, the GridControl arranges rows according to their indices in a data source.

When you execute a command bound to the GridControl.CustomColumnGroupCommand property, set the result as follows:

• 0 to combine the rows into the same group.
• 1 (or -1) to place the rows in different groups.

Related GitHub Examples

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

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#

wpf-data-grid-implement-custom-grouping/CS/CustomGrouping_MVVM/MainViewModel.cs#L39

    double y = Math.Floor(Convert.ToDouble(args.SecondValue) / 10);
    args.Result = x > 9 && y > 9 ? 0 : x.CompareTo(y);
}

wpf-data-grid-implement-custom-sorting/CS/CustomSorting_MVVM/MainViewModel.cs#L37

    int dayIndex2 = GetDayIndex(args.SecondValue);
    args.Result = dayIndex1.CompareTo(dayIndex2);
}

VB.NET

wpf-data-grid-implement-custom-grouping/VB/CustomGrouping_MVVM/MainViewModel.vb#L47

    Dim y As Double = Math.Floor(Convert.ToDouble(args.SecondValue) / 10)
    args.Result = If(x > 9 AndAlso y > 9, 0, x.CompareTo(y))
End Sub

wpf-data-grid-implement-custom-sorting/VB/CustomSorting_MVVM/MainViewModel.vb#L45

    Dim dayIndex2 As Integer = Me.GetDayIndex(args.SecondValue)
    args.Result = dayIndex1.CompareTo(dayIndex2)
End If