DetailBand.SortFields Property

Gets the collection of data fields used to sort the data in the report’s data source.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core

Declaration

C#

[SRCategory(ReportStringId.CatData)]
public GroupFieldCollection SortFields { get; }

VB.NET

<SRCategory(ReportStringId.CatData)>
Public ReadOnly Property SortFields As GroupFieldCollection

Property Value

Type	Description
GroupFieldCollection	A GroupFieldCollection object which represents the collection of data fields to sort by.

Remarks

Use the SortFields property to specify the data fields which the data in the report’s data source will be sorted by when creating the report’s document, and the order of sorting. The report’s data source can be accessed via its XtraReportBase.DataSource property.

Note

Note that since this property is declared for the DetailBand class, you can specify different sort data fields and sort orders for master and detail reports when creating a master-detail report using the DetailReportBand objects.

Related GitHub Examples

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

Reporting_how-to-sort-report-data-in-print-preview-by-using-a-drop-down-menu-t210208/CS/dxSampleGroupSort/SortReportTableHelpers/HelpSortItem.cs#L112

List<GroupField> fToRemove = new List<GroupField>();
foreach (GroupField field in DataBand.SortFields) {
    if (field.FieldName == FieldName) {

Reporting_how-to-sort-a-report-in-documentpreviewcontrol-t329474/CS/WpfApplication1/MainWindow.xaml.cs#L59

{
    ChangeSortOrder(Detail.SortFields[fieldName]);
}

VB.NET

Reporting_how-to-sort-report-data-in-print-preview-by-using-a-drop-down-menu-t210208/VB/dxSampleGroupSort/SortReportTableHelpers/HelpSortItem.vb#L109

Dim fToRemove As New List(Of GroupField)()
For Each field As GroupField In DataBand.SortFields
    If field.FieldName = FieldName Then

Reporting_how-to-sort-a-report-in-documentpreviewcontrol-t329474/VB/WpfApplication1/MainWindow.xaml.vb#L53

If Detail.SortFields.Any(Function(x) x.FieldName.Equals(fieldName)) Then
    ChangeSortOrder(Detail.SortFields(fieldName))
Else