<CheckBox x:Name="myCheckBox" Content="Custom Sort" Checked="myCheckBox_Checked" Unchecked="myCheckBox_Unchecked"> </CheckBox>
We recommend that you use the xamDataGrid control instead of the xamGrid control. The xamGrid is being planned for retirement over the next few years and will not receive any new features. We will continue to provide support and critical bug fixes for the xamGrid during this time. For help or questions on migrating your codebase to the xamDataGrid, please contact support.
In some situations it may not be ideal to use the default sorting algorithm. With the xamGrid™ control you can easily implement custom sort logic. You can get or set a custom IComparer template object using the Column object’s SortComparer property.
This topic will show you how to create your own custom IComparer implementation and how to attach it to a column.
Assumptions:
This topic assumes that you already have a xamGrid control bound to data on your page. For more information see the Binding xamGrid to Data topic.
In this walkthrough you will learn how to create a custom sort by implementing the IComparer interface. This walkthrough creates a class named MyCustomSort which has been designed to sort on the last character instead of the typical first character of the string.
Add a Microsoft Checkbox control to your page so that your end user can choose to use the custom sort. Set the following properties:
x:Name = myCheckBox
Content = Custom Sort
Checked = myCheckBox_Checked
Unchecked = myCheckBox_Unchecked
In XAML:
<CheckBox x:Name="myCheckBox" Content="Custom Sort" Checked="myCheckBox_Checked" Unchecked="myCheckBox_Unchecked"> </CheckBox>
Create a class named MyCustomSort that implements the IComparer interface. This class contains code that implements the Compare method that is a member of the IComparer interface.
In Visual Basic:
Public Class MyCustomSort
Implements IComparer(Of String)
Public Function Compare(ByVal x As String, ByVal y As String) As Integer _
Implements IComparer(Of String).Compare
Dim x1, y1 As String
' Get the last character of the string to sort on
x1 = x.Substring((x.Length - 1))
y1 = y.Substring((y.Length - 1))
Return x1.CompareTo(y1)
End Function
End Class
In C#:
public class MyCustomSort : IComparer<string>
{
public int Compare(string x, string y)
{
string x1, y1;
//Get the last character of the string to sort on
x1 = x.Substring(x.Length - 1);
y1 = y.Substring(y.Length - 1);
return x1.CompareTo(y1);
}
}
Within the myCheckBox_Checked event, set the SortComparer property of the ProductName column to the MyCustomSort object.
In Visual Basic:
Dim customSortColumn As Column = Me.dataGrid.Columns.DataColumns("ProductName")
customSortColumn.SortComparer = New MyCustomSort()
In C#:
private void myCheckBox_Checked(object sender, RoutedEventArgs e)
{
Column customSortColumn = this.MyGrid.Columns.DataColumns["ProductName"];
customSortColumn.SortComparer = new MyCustomSort();
}
Within the myCheckBox_Unchecked event, clear the SortComparer property.
In Visual Basic:
Dim clearCustomSortColumn As Column = Me.MyGrid.Columns.DataColumns("ProductName")
clearCustomSortColumn.SortComparer = Nothing
In C#:
private void myCheckBox_Unchecked(object sender, RoutedEventArgs e)
{
Column clearCustomSortColumn = this.MyGrid.Columns.DataColumns["ProductName"];
clearCustomSortColumn.SortComparer = null;
}
Save and run your project.
