GridSortInfo.FieldName Property

Gets or sets the field name of the column to sort. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.1.Core.dll

Declaration

C#

public string FieldName { get; set; }

VB.NET

Public Property FieldName As String

Property Value

Type	Description
String	A String value that specifies the field name of the column to sort.

Remarks

The FieldName property specifies the column whose values are sorted in the order specified by the ColumnBase.SortOrder property.

To learn more, see Sorting in Code.

Example

This example shows how to apply data sorting and grouping in XAML.

Since group rows are always sorted, data grouping requires data sorting. Sorting applied to group columns takes priority over other columns. To group data by one column in XAML, do the following:

• Create a GridSortInfo object and specify its GridSortInfo.FieldName and GridSortInfo.SortOrder properties. The GridSortInfo.FieldName property specifies the grouping column by its field name.
• Add the GridSortInfo object to the grid’s GridControl.SortInfo collection. This object must be the first element in this collection.
• Finally, set the grid’s GridControl.GroupCount property to 1. This specifies that the first element in the GridControl.SortInfo collection corresponds to the grouping column.

The image below shows the result:

C#

using System.ComponentModel;
using DevExpress.Xpf.Grid;

public Window1() {
    InitializeComponent();
    grid.DataSource =
        new dsNwindProductsTableAdapters.ProductsTableAdapter().GetData();
    CreateSortInfo(grid);
}
private void CreateSortInfo(GridControl grid) {
    grid.SortInfo.Add(new GridSortInfo("UnitPrice", ListSortDirection.Descending));
    grid.SortInfo.Add(new GridSortInfo("ProductName", ListSortDirection.Ascending));
    grid.GroupCount = 1;
}

XAML

<dxg:GridControl x:Name="grid" GroupCount="1">
    <dxg:GridControl.Columns>
        <dxg:GridColumn FieldName="ProductName"/>
        <dxg:GridColumn FieldName="UnitPrice"/>
        <dxg:GridColumn FieldName="UnitsOnOrder" Header="Units On Order"/>
    </dxg:GridControl.Columns>
    <dxg:GridControl.View>
        <dxg:TableView AutoWidth="True" ShowGroupedColumns="False"/>
    </dxg:GridControl.View>
    <dxg:GridControl.SortInfo>
        <dxg:GridSortInfo FieldName="UnitPrice" SortOrder="Descending"/>
        <dxg:GridSortInfo FieldName="ProductName" SortOrder="Ascending"/>
    </dxg:GridControl.SortInfo>
</dxg:GridControl>

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FieldName 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-embed-animation-into-grid-cells-e1532/CS/AnimateCells/Window1.xaml#L34

<dxg:GridControl.SortInfo>
    <dxg:GridSortInfo FieldName="Rank" />
</dxg:GridControl.SortInfo>

how-to-implement-the-drag-and-drop-capability-to-move-a-row-from-one-group-to-another-e1193/CS/Window1.xaml#L4

<dxg:GridControl.SortInfo>
    <dxg:GridSortInfo FieldName="Group" />
</dxg:GridControl.SortInfo>

how-to-handle-grid-commands-in-xaml-and-code-behind-e373/VB/Window1.xaml#L17

<dxg:GridControl.SortInfo>
    <dxg:GridSortInfo FieldName="X" SortOrder="Ascending" />
</dxg:GridControl.SortInfo>

how-to-synchronize-the-dxtreelist-with-the-icollectionview-collectionviewsource-e3238/CS/TreeListControlViewModel/TreeListControlDataModel.cs#L192

    GridSortInfo info = treeListControl.SortInfo[i];
    CollectionView.SortDescriptions.Add(new SortDescription(info.FieldName, info.SortOrder));
}

VB.NET

how-to-synchronize-the-dxtreelist-with-the-icollectionview-collectionviewsource-e3238/VB/TreeListControlViewModel/TreeListControlDataModel.vb#L223

    Dim info As GridSortInfo = treeListControl.SortInfo(i)
    CollectionView.SortDescriptions.Add(New SortDescription(info.FieldName, info.SortOrder))
Next i