ColumnBase.SortFieldName Property

Gets or sets another field by which data is sorted when sorting is applied to the current column.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v18.2.Core.dll

Declaration

C#

public string SortFieldName { get; set; }

VB.NET

Public Property SortFieldName As String

Property Value

Type	Description
String	A string that specifies a field name.

Remarks

GridControl’s default sorting and grouping behavior is as follows. On clicking a column header or changing the ColumnBase.SortOrder property, data is sorted by the corresponding field. On grouping against a column, data groups are created based on the values of this column.

The SortFieldName property allows you to change this behavior. When sorting/grouping is applied to a specific column, you can sort/group data against another field instead. To do this, set the SortFieldName property to the required field name.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SortFieldName 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#

how-to-sort-group-data-in-a-gridcolumn-against-data-in-another-gridcolumn-e2937/VB/dxSampleGrid/MainWindow.xaml#L14

<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="FirstName" SortFieldName="CustomSortNumber" />
    <dxg:GridColumn FieldName="CustomSortNumber" />