SortDirection Property (ColumnBase)

In This Topic

Gets a value indicating the direction in which the values contained in the column are sorted.

Syntax

Visual Basic
C#

'Declaration
 
Public ReadOnly Property SortDirection As SortDirection

'Usage
 
Dim instance As ColumnBase
Dim value As SortDirection
 
value = instance.SortDirection

public SortDirection SortDirection {get;}

Property Value

A SortDirection value indicating the direction in which the values contained in the column are sorted. By default, SortDirection.None.

Member	Description
None	The column is not sorted.
Ascending	The column's values are sorted in an ascending direction.
Descending	The column's values are sorted in a descending direction.

Example

All examples in this topic assume that the grid is bound to the Orders table of the Northwind database, unless stated otherwise.

The following example demonstrates how to sort the data items in an ascending direction according to the values of the ShipCountry column.

XAML

<Grid xmlns:scm="clr-namespace:System.ComponentModel;assembly=WindowsBase" 
      xmlns:xcdg="http://schemas.xceed.com/wpf/xaml/datagrid"> 
  <Grid.Resources> 
    <xcdg:DataGridCollectionViewSource x:Key="cvs_orders" 
                                     Source="{Binding Source={x:Static Application.Current}, 
                                                       Path=Orders}"> 
 
     <xcdg:DataGridCollectionViewSource.SortDescriptions> 
       <scm:SortDescription PropertyName="ShipCountry" Direction="Ascending"/> 
     </xcdg:DataGridCollectionViewSource.SortDescriptions> 
    </xcdg:DataGridCollectionViewSource>           
  </Grid.Resources> 
 
  <xcdg:DataGridControl x:Name="OrdersGrid" 
                        ItemsSource="{Binding Source={StaticResource cvs_orders}}"> 
    <xcdg:DataGridControl.Columns> 
      <xcdg:Column FieldName="ShipCountry" VisiblePosition="0"/> 
    </xcdg:DataGridControl.Columns> 
  </xcdg:DataGridControl> 
</Grid>

The following example demonstrates how to provide a custom sort comparer that sorts addresses. The AddressComparer class (provided below) will first sort addresses which begin with numeric values by street name and then civic number. Address that do not have a civic number will be sorted alphabetically.

XAML

<Grid xmlns:xcdg="http://schemas.xceed.com/wpf/xaml/datagrid" 
      xmlns:local="clr-namespace:Xceed.Wpf.Documentation"> 
   <Grid.Resources> 
      <local:AddressComparer x:Key="addressComparer"/> 
      <xcdg:DataGridCollectionViewSource x:Key="cvs_orders" 
                                         Source="{Binding Source={x:Static Application.Current}, 
                                                          Path=Orders}" 
                                         AutoCreateItemProperties="False"> 
         <xcdg:DataGridCollectionViewSource.ItemProperties> 
            <xcdg:DataGridItemProperty Name="ShipCountry" /> 
            <xcdg:DataGridItemProperty Name="ShipCity" /> 
            <xcdg:DataGridItemProperty Name="ShipAddress" 
                                       SortComparer="{StaticResource addressComparer}"/> 
            <xcdg:DataGridItemProperty Name="ShipVia" /> 
         </xcdg:DataGridCollectionViewSource.ItemProperties> 
      </xcdg:DataGridCollectionViewSource> 
   </Grid.Resources> 
   <xcdg:DataGridControl x:Name="OrdersGrid" 
                         ItemsSource="{Binding Source={StaticResource cvs_orders}}">          
      <xcdg:DataGridControl.View> 
         <xcdg:TableView ColumnStretchMode="StretchAll"/> 
      </xcdg:DataGridControl.View> 
   </xcdg:DataGridControl> 
</Grid>

The following code provides the implementation of the AddressComparer class.

Visual Basic

Imports System
Imports System.Collections
Imports System.Data
Namespace Xceed.Wpf.Documentation

  Public Class AddressComparer
               Implements IComparer

    Public Sub New()
    End Sub
    Public Function Compare( x As Object, y As Object ) As Integer Implements IComparer.Compare
      Dim stringX As String = CType( x, String )
      Dim stringY As String = Ctyle( y, String )
      Const digits As String = "0123456789"
      If( ( digits.IndexOf( stringX( 0 ) ) >= 0 ) And ( digits.IndexOf( stringY( 0 ) ) >= 0 ) ) Then
        Dim index As Integer = 0
        Dim xNumber As System.Text.StringBuilder = New System.Text.StringBuilder()
        While( ( index < stringX.Length ) And ( digits.IndexOf( stringX( index ) ) >= 0 ) )
          xNumber.Append( stringX( index ) )
          index++
        End While
        index = 0
        Dim yNumber As System.Text.StringBuilder = New System.Text.StringBuilder()
        While( ( index < stringY.Length ) And ( digits.IndexOf( stringY( index ) ) >= 0 ) )
          yNumber.Append( stringY( index ) )
          index++
        End While
        Dim xValue = Long.Parse( xNumber.ToString() )
        Dim yValue As Long = Long.Parse( yNumber.ToString() )
        If( xValue > yValue ) Then
          Return 1
        End If
        If( xValue < yValue ) Then
          Return -1
        End If
        Return stringX.CompareTo( stringY )
      Else
        Return stringX.CompareTo( stringY )
      End If
    End Function
  End Class
End Namespace

The following code provides the implementation of the AddressComparer class.

using System;
using System.Collections;
using System.Data;
namespace Xceed.Wpf.Documentation
{
public class AddressComparer: IComparer
{
  public AddressComparer()
  {
  }

  int IComparer.Compare( object x, object y )
  {
    string stringX = ( string )x;
    string stringY = ( string )y;

    const string digits = "0123456789";
    if( ( digits.IndexOf( stringX[ 0 ] ) >= 0 ) && ( digits.IndexOf( stringY[ 0 ] ) >= 0 ) )
    {
      int index = 0;
      System.Text.StringBuilder xNumber = new System.Text.StringBuilder();

      while( ( index < stringX.Length ) && ( digits.IndexOf( stringX[ index ] ) >= 0 ) )
      {
        xNumber.Append( stringX[ index ] );
        index++;
      }

      index = 0;
      System.Text.StringBuilder yNumber = new System.Text.StringBuilder();

      while( ( index < stringY.Length ) && ( digits.IndexOf( stringY[ index ] ) >= 0 ) )
      {
        yNumber.Append( stringY[ index ] );
        index++;
      }

      long xValue = long.Parse( xNumber.ToString() );
      long yValue = long.Parse( yNumber.ToString() );

      if( xValue > yValue )
        return 1;

      if( xValue < yValue )
        return -1;

      return stringX.CompareTo( stringY );
    }
    else
    {
      return stringX.CompareTo( stringY );
    }
  }
}
}

Requirements

Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ColumnBase Class
ColumnBase Members

Send Feedback

Business Suite

Ultimate Suite

Property Value

Reference