Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to I display a sort arrow in the header of a list view column using C#?

Tags:

c#

listview

How can I display a sort arrow in the header of the sorted column in a list view which follows the native look of the operating system?

like image 590
Andrew Moore Avatar asked Oct 31 '08 16:10

Andrew Moore


People also ask

How do I sort items in ListView?

Click the various column headers in the ListView control. When you click the header, the contents of the ListView control are sorted in ascending order based on the column that you click. When you click the same column header again, that column is sorted in descending order.

What is a sortable list view?

Lots of objects let you view records in lists, also called “list views”. You can sort the records by one of the field columns. For example, you can sort the All Accounts list view by the Account Name field column, Billing State/Province field column, and others. You can also sort custom list views.


2 Answers

You can use the following extension method to set the sort arrow to a particular column:

[EditorBrowsable(EditorBrowsableState.Never)] public static class ListViewExtensions {     [StructLayout(LayoutKind.Sequential)]     public struct HDITEM     {         public Mask mask;         public int cxy;         [MarshalAs(UnmanagedType.LPTStr)] public string pszText;         public IntPtr hbm;         public int cchTextMax;         public Format fmt;         public IntPtr lParam;         // _WIN32_IE >= 0x0300          public int iImage;         public int iOrder;         // _WIN32_IE >= 0x0500         public uint type;         public IntPtr pvFilter;         // _WIN32_WINNT >= 0x0600         public uint state;          [Flags]         public enum Mask         {             Format = 0x4,       // HDI_FORMAT         };          [Flags]         public enum Format         {             SortDown = 0x200,   // HDF_SORTDOWN             SortUp = 0x400,     // HDF_SORTUP         };     };      public const int LVM_FIRST = 0x1000;     public const int LVM_GETHEADER = LVM_FIRST + 31;      public const int HDM_FIRST = 0x1200;     public const int HDM_GETITEM = HDM_FIRST + 11;     public const int HDM_SETITEM = HDM_FIRST + 12;      [DllImport("user32.dll", CharSet = CharSet.Auto, SetLastError = true)]     public static extern IntPtr SendMessage(IntPtr hWnd, UInt32 msg, IntPtr wParam, IntPtr lParam);      [DllImport("user32.dll", CharSet = CharSet.Auto, SetLastError = true)]     public static extern IntPtr SendMessage(IntPtr hWnd, UInt32 msg, IntPtr wParam, ref HDITEM lParam);      public static void SetSortIcon(this ListView listViewControl, int columnIndex, SortOrder order)     {         IntPtr columnHeader = SendMessage(listViewControl.Handle, LVM_GETHEADER, IntPtr.Zero, IntPtr.Zero);         for (int columnNumber = 0; columnNumber <= listViewControl.Columns.Count - 1; columnNumber++)         {             var columnPtr = new IntPtr(columnNumber);             var item = new HDITEM                 {                     mask = HDITEM.Mask.Format                 };              if (SendMessage(columnHeader, HDM_GETITEM, columnPtr, ref item) == IntPtr.Zero)             {                 throw new Win32Exception();             }              if (order != SortOrder.None && columnNumber == columnIndex)             {                 switch (order)                 {                     case SortOrder.Ascending:                         item.fmt &= ~HDITEM.Format.SortDown;                         item.fmt |= HDITEM.Format.SortUp;                         break;                     case SortOrder.Descending:                         item.fmt &= ~HDITEM.Format.SortUp;                         item.fmt |= HDITEM.Format.SortDown;                         break;                 }             }             else             {                 item.fmt &= ~HDITEM.Format.SortDown & ~HDITEM.Format.SortUp;             }              if (SendMessage(columnHeader, HDM_SETITEM, columnPtr, ref item) == IntPtr.Zero)             {                 throw new Win32Exception();             }         }     } } 

Then, you can call the extension method like such:

myListView.SetSortIcon(0, SortOrder.Ascending); 

It works by using P/Invoke to:

  • Get the handle to the header control for a list view using the LVM_GETHEADER message.
  • Get the information about a header column using the HDM_GETITEM message.
  • It then modifies the fmt to set / clear the HDF_SORTDOWN and HDF_SORTUP flags on the returned HDITEM structure.
  • Finally it re-sets the information usintg the HDM_SETITEM message.

This is what it looks like:

Arrows on a list view column

like image 123
Andrew Moore Avatar answered Sep 18 '22 14:09

Andrew Moore


Great answer by Andrew. If Anyone is looking for the VB.net equivalent here it is:

Public Module ListViewExtensions     Public Enum SortOrder         None         Ascending         Descending     End Enum      <StructLayout(LayoutKind.Sequential)>     Public Structure HDITEM         Public theMask As Mask         Public cxy As Integer         <MarshalAs(UnmanagedType.LPTStr)>         Public pszText As String         Public hbm As IntPtr         Public cchTextMax As Integer         Public fmt As Format         Public lParam As IntPtr         ' _WIN32_IE >= 0x0300          Public iImage As Integer         Public iOrder As Integer         ' _WIN32_IE >= 0x0500         Public type As UInteger         Public pvFilter As IntPtr         ' _WIN32_WINNT >= 0x0600         Public state As UInteger          <Flags()>         Public Enum Mask             Format = &H4       ' HDI_FORMAT         End Enum           <Flags()>         Public Enum Format             SortDown = &H200 ' HDF_SORTDOWN             SortUp = &H400     ' HDF_SORTUP         End Enum     End Structure      Public Const LVM_FIRST As Integer = &H1000     Public Const LVM_GETHEADER As Integer = LVM_FIRST + 31      Public Const HDM_FIRST As Integer = &H1200     Public Const HDM_GETITEM As Integer = HDM_FIRST + 11     Public Const HDM_SETITEM As Integer = HDM_FIRST + 12      <DllImport("user32.dll", CharSet:=CharSet.Auto, SetLastError:=True)>     Public Function SendMessage(hWnd As IntPtr, msg As UInt32, wParam As IntPtr, lParam As IntPtr) As IntPtr     End Function      <DllImport("user32.dll", CharSet:=CharSet.Auto, SetLastError:=True)>     Public Function SendMessage(hWnd As IntPtr, msg As UInt32, wParam As IntPtr, ByRef lParam As HDITEM) As IntPtr     End Function      <Extension()>     Public Sub SetSortIcon(listViewControl As ListView, columnIndex As Integer, order As SortOrder)         Dim columnHeader As IntPtr = SendMessage(listViewControl.Handle, LVM_GETHEADER, IntPtr.Zero, IntPtr.Zero)         For columnNumber As Integer = 0 To listViewControl.Columns.Count - 1              Dim columnPtr As New IntPtr(columnNumber)             Dim item As New HDITEM              item.theMask = HDITEM.Mask.Format              If SendMessage(columnHeader, HDM_GETITEM, columnPtr, item) = IntPtr.Zero Then Throw New Win32Exception              If order <> SortOrder.None AndAlso columnNumber = columnIndex Then                 Select Case order                     Case SortOrder.Ascending                         item.fmt = item.fmt And Not HDITEM.Format.SortDown                         item.fmt = item.fmt Or HDITEM.Format.SortUp                     Case SortOrder.Descending                         item.fmt = item.fmt And Not HDITEM.Format.SortUp                         item.fmt = item.fmt Or HDITEM.Format.SortDown                 End Select             Else                 item.fmt = item.fmt And Not HDITEM.Format.SortDown And Not HDITEM.Format.SortUp             End If              If SendMessage(columnHeader, HDM_SETITEM, columnPtr, item) = IntPtr.Zero Then Throw New Win32Exception         Next     End Sub End Module 
like image 29
Jesse Avatar answered Sep 17 '22 14:09

Jesse