SortProperty Class

An element in the SortingCollection.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Data.v18.1.dll

Declaration

C#

[TypeConverter(typeof(SortProperty.SortPropertyConverter))]
public sealed class SortProperty

VB.NET

<TypeConverter(GetType(SortProperty.SortPropertyConverter))>
Public NotInheritable Class SortProperty

Related API Members

The following members accept/return SortProperty objects:

• SortingCollection.Item[Int32]

Remarks

The SortProperty.PropertyName property specifies the name of a property which identifies the sorted column. The sort order is specified by the SortProperty.Direction property.

C#

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

VB.NET

Dim sortCollection As DevExpress.Xpo.SortingCollection = New DevExpress.Xpo.SortingCollection()
sortCollection.Add(New SortProperty("Name", DevExpress.Xpo.DB.SortingDirection.Ascending))
XpCollection1.Sorting = sortCollection

Related GitHub Examples

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

XAF_how-to-allow-users-to-create-filter-via-the-criteria-editor-before-previewing-a-report-e1607/CS/DXSample.Module/CriteriaReportParametersObject.cs#L24

public override SortProperty[] GetSorting() {
    return new SortProperty[0];

XAF_how-to-use-custom-reportparametersobject-to-filter-detail-reports-detailreportband-e1396/CS/WinSample.Module/MyReportParametersObject.cs#L17

}
public override SortProperty[] GetSorting() {
    return new SortProperty[] { new SortProperty("MasterName", SortingDirection.Ascending) };

XPO_how-to-create-and-use-the-joinoperand-using-linq-to-xpo-and-criteria-operators-e1883/CS/E1883/Program.cs#L30

using (XPCollection<Person> result1 =
    new XPCollection<Person>(session, op1, new SortProperty("Name", SortingDirection.Ascending))) {
    CheckResult(result1);

XPO_how-to-create-persistent-classes-mapped-to-tables-with-a-composite-primary-key-at-runtime-e4606/CS/XpoConsoleApplication/Program.cs#L86

XPView xpv = new XPView(uow, ciTask);
xpv.Sorting.Add(new SortProperty("Project", DevExpress.Xpo.DB.SortingDirection.Ascending));
xpv.Sorting.Add(new SortProperty("No", DevExpress.Xpo.DB.SortingDirection.Ascending));

XAF_how-to-represent-a-collection-property-using-a-checked-list-box-e1807/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));
}

VB.NET

XAF_how-to-allow-users-to-create-filter-via-the-criteria-editor-before-previewing-a-report-e1607/VB/DXSample.Module/CriteriaReportParametersObject.vb#L28

Public Overrides Function GetSorting() As SortProperty()
    Return New SortProperty(){}

XAF_how-to-use-custom-reportparametersobject-to-filter-detail-reports-detailreportband-e1396/VB/WinSample.Module/MyReportParametersObject.vb#L21

End Function
Public Overrides Function GetSorting() As SortProperty()
    Return New SortProperty() {New SortProperty("MasterName", SortingDirection.Ascending)}

XPO_how-to-create-and-use-the-joinoperand-using-linq-to-xpo-and-criteria-operators-e1883/VB/E1883/Program.vb#L29

Console.WriteLine("Testing the CriteriaOperator created using constructors")
Using result1 As New XPCollection(Of Person)(session, op1, New SortProperty("Name", SortingDirection.Ascending))
    CheckResult(result1)

XPO_how-to-create-persistent-classes-mapped-to-tables-with-a-composite-primary-key-at-runtime-e4606/VB/XpoConsoleApplication/Program.vb#L90

Dim xpv As New XPView(uow, ciTask)
xpv.Sorting.Add(New SortProperty("Project", DevExpress.Xpo.DB.SortingDirection.Ascending))
xpv.Sorting.Add(New SortProperty("No", DevExpress.Xpo.DB.SortingDirection.Ascending))

XAF_how-to-represent-a-collection-property-using-a-checked-list-box-e1807/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

Inheritance

Object

SortProperty