XPBaseCollection.Sorting Property

Gets or sets the sort settings for the current collection.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v18.2.dll

Declaration

C#

public SortingCollection Sorting { get; set; }

VB.NET

Public Property Sorting As SortingCollection

Property Value

Type	Description
SortingCollection	The SortingCollection that specifies the sort order for the collection.

Remarks

Calling the SortingCollection‘s Add, Remove and Clear methods is not allowed. To sort a collection, a new SortingCollection object must be created and assigned to the Sorting property.

C#

XPCollection<MyObject> xpCollection1 = new XPCollection<MyObject>();
SortingCollection sorting = new SortingCollection();
sorting.Add(new SortProperty("PropertyA", DevExpress.Xpo.DB.SortingDirection.Ascending));
xpCollection1.Sorting = sorting;
...

SortingCollection newSorting = new SortingCollection();
newSorting.Add(new SortProperty("PropertyB", DevExpress.Xpo.DB.SortingDirection.Ascending));
xpCollection1.Sorting = newSorting;

To learn more, see Sorting Basics.

Note

For performance reasons, we recommend that you not use the JoinOperand in sort properties, as this significantly increases the number of queries sent to the server.

Example

The following example demonstrates how to sort a collection (xpCollectionPerson) in ascending order against a ‘Name’ field.

C#

using DevExpress.Xpo;
using DevExpress.Xpo.DB;

SortingCollection sortCollection = new SortingCollection();
sortCollection.Add(new SortProperty("Name", SortingDirection.Ascending));
xpCollectionPerson.Sorting = sortCollection;

VB.NET

Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB

Dim sortCollection As SortingCollection = New SortingCollection()
sortCollection.Add(New SortProperty("Name", SortingDirection.Ascending))
XpCollectionPerson.Sorting = sortCollection

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Sorting 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#

XAF_how-to-sort-a-nested-listviewat-the-business-objects-level-in-code-e1253/CS/WinWebSolution.Module/SortListViewController.cs#L76

bool isSortingAdded = false;
foreach (SortProperty sortProperty in collection.Sorting) {
    if (sortProperty.Property.Equals(DevExpress.Data.Filtering.CriteriaOperator.Parse(property))) {

how-to-bind-an-aspnet-mvc-gridview-extension-to-a-table-with-an-unknown-schema-using-custo-t602001/CS/XPCustomBindingExample/XPO/XpoBindingHandlers.cs#L32

data.Criteria = CriteriaOperator.Parse(e.FilterExpression) & GetGroupFilter(e.GroupInfoList);
data.Sorting = GetSorting(e.State.SortedColumns, e.StartDataRowIndex != 0 || e.DataRowCount != 0);
data.SkipReturnedObjects = e.StartDataRowIndex;

VB.NET

XAF_how-to-sort-a-nested-listviewat-the-business-objects-level-in-code-e1253/VB/WinWebSolution.Module/SortListViewController.vb#L101

Dim isSortingAdded As Boolean = False
For Each sortProperty As SortProperty In collection.Sorting
    If sortProperty.Property.Equals(DevExpress.Data.Filtering.CriteriaOperator.Parse([property])) Then

how-to-bind-an-aspnet-mvc-gridview-extension-to-a-table-with-an-unknown-schema-using-custo-t602001/VB/XPCustomBindingExample/XPO/XpoBindingHandlers.vb#L32

data.Criteria = CriteriaOperator.Parse(e.FilterExpression) And GetGroupFilter(e.GroupInfoList)
data.Sorting = GetSorting(e.State.SortedColumns, e.StartDataRowIndex <> 0 OrElse e.DataRowCount <> 0)
data.SkipReturnedObjects = e.StartDataRowIndex