SortingCollection Class

A collection of SortProperty objects.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v23.2.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

[ListBindable(BindableSupport.No)]
public sealed class SortingCollection :
    IList,
    ICollection,
    IEnumerable,
    IEnumerable<SortProperty>

VB.NET

<ListBindable(BindableSupport.No)>
Public NotInheritable Class SortingCollection
    Implements IList,
               ICollection,
               IEnumerable,
               IEnumerable(Of SortProperty)

Related API Members

The following members return SortingCollection objects:

Library	Related API Members
eXpressApp Framework	XPObjectSpace.CreateSortingCollection(IList<SortProperty>)
eXpress Persistent Objects	ObjectsQuery.Sorting
	ObjectStubsQuery.Sorting
	XPBaseCollection.Sorting
	XPCursor.Sorting
	XPDataView.Sorting
	XPObjectSource.Sorting
	XPView.Sorting

Remarks

The collection can be assigned to the XPCollection, XPView, XPDataView, or XPCursor object via an object’s Sorting property.

Note

Don’t make your code dependent on the order of records returned by these objects, unless you’ve explicitly sorted them. By default, if the XPCollection, XPView, XPDataView, or XPCursor is not sorted, records will be returned in an arbitrary order. This mimics the behavior of the SQL SELECT statement used in the same circumstances.

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

Inheritance

Object

SortingCollection