SortingCollection.Add(SortProperty) Method

Adds the specified SortProperty object to the collection.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

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

NuGet Package: DevExpress.Xpo

Declaration

C#

public void Add(
    SortProperty sortProperty
)

VB.NET

Public Sub Add(
    sortProperty As SortProperty
)

Parameters

Name	Type	Description
sortProperty	SortProperty	A SortProperty object to add to the collection.

Remarks

Adding an element to the collection doesn’t automatically apply sorting by the corresponding property (column). To re-sort data, create a new SortingCollection object, populate it with the customized SortProperty objects and reassign it to the XPBaseCollection.Sorting property.

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 Add(SortProperty) method.

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#

asp-net-mvc-grid-custom-binding-and-xpo/CS/XPCustomBindingExample/XPO/XpoBindingHandlers.cs#L94

    SortProperty sortProperty = new SortProperty(sortedColumn.FieldName, sortingDirection);
    sorting.Add(sortProperty);
}

how-to-bind-wpf-grid-to-data/CS/CodeBehind/XPO/LocalData/MainWindow.xaml.cs#L17

var xpCollection = new XPCollection<User>(_UnitOfWork);
xpCollection.Sorting.Add(new SortProperty(nameof(User.Oid), DevExpress.Xpo.DB.SortingDirection.Ascending));
grid.ItemsSource = xpCollection;

wpf-data-grid-implement-crud-operations/CS/CodeBehind/XPO/LocalData/MainWindow.xaml.cs#L18

var xpCollection = new XPCollection<User>(_UnitOfWork);
xpCollection.Sorting.Add(new SortProperty(nameof(User.Oid), DevExpress.Xpo.DB.SortingDirection.Ascending));
grid.ItemsSource = xpCollection;

xaf-how-to-display-a-collection-property-as-a-checked-list-box/CS/DXExample.Module.Win/WinCheckedListBoxPropertyEditor.cs#L30

} else if (!String.IsNullOrEmpty(classInfo.DefaultProperty)) {
    dataSource.Sorting.Add(new SortProperty(classInfo.DefaultProperty, DevExpress.Xpo.DB.SortingDirection.Ascending));
}

XPO_how-to-implement-custom-aggregates/CS/XpoCustomAggregate/Form1.cs#L24

xpView.AddProperty("PriceVariance", CriteriaOperator.Parse("[Orders][].STDEVP([Price])"));
xpView.Sorting.Add(new SortProperty("ContactName", DevExpress.Xpo.DB.SortingDirection.Ascending));
gridControl1.DataSource = xpView;

VB.NET

asp-net-mvc-grid-custom-binding-and-xpo/VB/XPCustomBindingExample/XPO/XpoBindingHandlers.vb#L97

    Dim sortProperty As New SortProperty(sortedColumn.FieldName, sortingDirection)
    sorting.Add(sortProperty)
Next sortedColumn

how-to-bind-wpf-grid-to-data/VB/CodeBehind/XPO/LocalData/MainWindow.xaml.vb#L14

Dim xpCollection = New XPCollection(Of User)(_UnitOfWork)
xpCollection.Sorting.Add(New SortProperty(NameOf(User.Oid), DevExpress.Xpo.DB.SortingDirection.Ascending))
grid.ItemsSource = xpCollection

xaf-how-to-display-a-collection-property-as-a-checked-list-box/VB/DXExample.Module.Win/WinCheckedListBoxPropertyEditor.vb#L34

ElseIf (Not String.IsNullOrEmpty(classInfo.DefaultProperty)) Then
    dataSource.Sorting.Add(New SortProperty(classInfo.DefaultProperty, DevExpress.Xpo.DB.SortingDirection.Ascending))
End If

XPO_how-to-implement-custom-aggregates/VB/XpoCustomAggregate/Form1.vb#L25

xpView.AddProperty("PriceVariance", CriteriaOperator.Parse("[Orders][].STDEVP([Price])"))
xpView.Sorting.Add(New SortProperty("ContactName", DevExpress.Xpo.DB.SortingDirection.Ascending))
gridControl1.DataSource = xpView