【C#】ListViewの仮想化 ソート処理 追加メモ

public class ListViewSort
{
	/// <summary>
	/// 2 つの Unicode 文字列を比較
	/// </summary>
	/// <param name="x"></param>
	/// <param name="y"></param>
	/// <returns></returns>
	[System.Runtime.InteropServices.DllImport("shlwapi.dll",
	CharSet = System.Runtime.InteropServices.CharSet.Unicode,
	ExactSpelling = true)]
	private static extern int StrCmpLogicalW(string x, string y);

	private int lastSortCol = 0;							// 前回ソートカラム
	private SortOrder lastSortOrder = SortOrder.Ascending;	// 前回ソート向き
	private List<CompareType>? lstType = null;				// 比較種類リスト


	/// <summary>
	/// 比較種類
	/// </summary>
	public enum CompareType
	{
		typeStr,        // 文字列
		typeInt,        // 整数
		typeDateTime,   // 日時
		typeNature      // 自然順
	}

	/// <summary>
	/// 比較種類追加(カラムごと)
	/// </summary>
	/// <param name="type">比較種類</param>
	public void addCompareType(CompareType type)
	{
		if (lstType == null)
		{
			lstType = new List<CompareType>();
		}

		lstType.Add(type);
	}

	/// <summary>
	/// リストソート
	/// </summary>
	/// <param name="tagList">ListView仮想化 リストデータ</param>
	/// <param name="col">選択カラム番号</param>
	/// <returns></returns>
	public List<ListViewItem> SortList(List<ListViewItem> tagList, int col)
	{
		if (tagList == null)
		{
			return new List<ListViewItem>();
		}

		// 前回ソートカラムと同じカラムが選択された場合に、ソート向きを切り替える
		if (lastSortCol == col)
		{
			if (lastSortOrder == SortOrder.Ascending)
			{
				lastSortOrder = SortOrder.Descending;
			}
			else if (lastSortOrder == SortOrder.Descending)
			{
				lastSortOrder = SortOrder.Ascending;
			}
		}

		lastSortCol = col;

		if (lstType != null && lstType.Count > col)
		{
			switch (lstType[col])
			{
				case CompareType.typeStr:       // 文字列
					tagList.Sort((a, b) => CompareStr(a, b, col, lastSortOrder));
					break;
				case CompareType.typeInt:       // 数値
					tagList.Sort((a, b) => CompareImt(a, b, col, lastSortOrder));
					break;
				case CompareType.typeDateTime:  // 日時
					tagList.Sort((a, b) => CompareDateTime(a, b, col, lastSortOrder));
					break;
				case CompareType.typeNature:    // 自然検索
					tagList.Sort((a, b) => CompareNature(a, b, col, lastSortOrder));
					break;
				default:
					break;
			}
		}

		return tagList;
	}


	/// <summary>
	/// 文字列ソート
	/// </summary>
	/// <param name="x">比較データ</param>
	/// <param name="y">比較データ</param>
	/// <param name="col">選択カラム番号</param
	/// <param name="order">ソート向き</param>
	/// <returns></returns>
	private int CompareStr(object x, object y, int col, SortOrder order)
	{
		ListViewItem a = (ListViewItem)x;
		ListViewItem b = (ListViewItem)y;

		int ret = a.SubItems[col].Text.CompareTo(b.SubItems[col].Text);

		if (order == SortOrder.Descending)
		{
			ret = -ret;
		}

		return ret;
	}

	/// <summary>
	/// 数値ソート
	/// </summary>
	/// <param name="x">比較データ</param>
	/// <param name="y">比較データ</param>
	/// <param name="col">選択カラム番号</param
	/// <param name="order">ソート向き</param>
	/// <returns></returns>
	private int CompareImt(object x, object y, int col, SortOrder order)
	{
		ListViewItem a = (ListViewItem)x;
		ListViewItem b = (ListViewItem)y;

		Int32.TryParse(a.SubItems[col].Text, out int numA);
		Int32.TryParse(b.SubItems[col].Text, out int numB);

		int ret = numA.CompareTo(numB);

		if (order == SortOrder.Descending)
		{
			ret = -ret;
		}

		return ret;
	}

	/// <summary>
	/// 日時ソート
	/// </summary>
	/// <param name="x">比較データ</param>
	/// <param name="y">比較データ</param>
	/// <param name="col">選択カラム番号</param
	/// <param name="order">ソート向き</param>
	/// <returns></returns>
	private int CompareDateTime(object x, object y, int col, SortOrder order)
	{
		ListViewItem a = (ListViewItem)x;
		ListViewItem b = (ListViewItem)y;

		DateTime.TryParse(a.SubItems[col].Text, out DateTime dateA);
		DateTime.TryParse(b.SubItems[col].Text, out DateTime dateB);

		int ret = dateA.CompareTo(dateB);

		if (order == SortOrder.Descending)
		{
			ret = -ret;
		}

		return ret;
	}

	/// <summary>
	/// 自然ソート
	/// </summary>
	/// <param name="x"></param>
	/// <param name="y"></param>
	/// <param name="col"></param
	/// <param name="order"></param>
	/// <returns></returns>
	private int CompareNature(object x, object y, int col, SortOrder order)
	{
		ListViewItem a = (ListViewItem)x;
		ListViewItem b = (ListViewItem)y;

		int ret = StrCmpLogicalW(a.SubItems[col].Text,
					b.SubItems[col].Text);

		if (order == SortOrder.Descending)
		{
			ret = -ret;
		}

		return ret;
	}
}

public partial class Form1 : Form
{
	// リストビューデータ
	private List<ListViewItem> listItem = new List<ListViewItem>();

	// リストソートクラス
	private ListViewSort lvSort;

	// テストデータ配列
	private string[,] aryTestData = new string[10, 4] {
		{ "a001", "100", "2022/01/02 01:02:03", "2"},
		{ "a002", "50", "2022/11/03 01:02:03", "10"},
		{ "b001", "111", "2022/01/01 01:02:03", "21"},
		{ "b002", "33", "2022/03/03 01:02:03", "3"},
		{ "b003", "a2", "2021/01/01 01:02:03", "30"},
		{ "c001", "3", "2022/02/22 01:02:03", "111"},
		{ "c002", "50", "2023/01/01 01:02:03", "1"},
		{ "d001", "11", "2020/03/21 01:02:03", "22"},
		{ "e002", "1", "2022/12/12 01:02:03", "01"},
		{ "f003", "99", "2022/01/01 10:10:10", "05"},
	};

	/// <summary>
	/// コンストラクタ
	/// </summary>
	public Form1()
	{
		InitializeComponent();
	}

	/// <summary>
	/// フォームロード
	/// </summary>
	/// <param name="sender"></param>
	/// <param name="e"></param>
	private void Form1_Load(object sender, EventArgs e)
	{
		// リストビューのヘッダー設定
		listView1.View = View.Details;
		listView1.Clear();
		listView1.Columns.Add("文字列", 100, HorizontalAlignment.Left);
		listView1.Columns.Add("数値", 100, HorizontalAlignment.Right);
		listView1.Columns.Add("日時", 200, HorizontalAlignment.Right);
		listView1.Columns.Add("自然検索", 100, HorizontalAlignment.Left);

		// リストビューデータ表示イベント設定
		listView1.RetrieveVirtualItem += new RetrieveVirtualItemEventHandler(listView1_RetrieveVirtualItem);

		// 仮想モード オン
		listView1.VirtualMode = true;
		listView1.VirtualListSize = 0;

		// テストデータ追加
		for (int i = 0; i < 10; i++)
		{
			ListViewItem item = new ListViewItem(aryTestData[i, 0]);

			// 各列の内容を設定
			item.SubItems.Add(aryTestData[i, 1]);
			item.SubItems.Add(aryTestData[i, 2]);
			item.SubItems.Add(aryTestData[i, 3]);

			listItem.Add(item);
		}

		listView1.VirtualListSize = listItem.Count;

		// リストビュー カラムクリックイベント設定
		this.listView1.ColumnClick += new ColumnClickEventHandler(ColumnClick);

		// リストソートクラス設定
		lvSort = new ListViewSort();
		lvSort.addCompareType(ListViewSort.CompareType.typeStr);        // 1カラム目 文字列ソート
		lvSort.addCompareType(ListViewSort.CompareType.typeInt);        // 2カラム目 数値ソート
		lvSort.addCompareType(ListViewSort.CompareType.typeDateTime);   // 3カラム目 日時ソート
		lvSort.addCompareType(ListViewSort.CompareType.typeNature);     // 4カラム目 自然検索
	}

	/// <summary>
	/// リストビューデータ表示(仮想)
	/// </summary>
	/// <param name="sender"></param>
	/// <param name="e"></param>
	private void listView1_RetrieveVirtualItem(object? sender, RetrieveVirtualItemEventArgs e)
	{
		if (e.ItemIndex < listItem.Count)
		{
			if (e.Item == null)
			{
				e.Item = new ListViewItem();
			}

			e.Item = listItem[e.ItemIndex];
		}
	}

	/// <summary>
	/// リストビューカラムクリックイベント
	/// </summary>
	/// <param name="o"></param>
	/// <param name="e"></param>
	private void ColumnClick(object? o, ColumnClickEventArgs e)
	{
		SortManager(e.Column);
	}

	/// <summary>
	/// ソート管理
	/// </summary>
	/// <param name="col"></param>
	private void SortManager(int col)
	{
		// リストソート
		listItem = lvSort.SortList(listItem, col);

		// リフレッシュ
		listView1.Refresh();
	}
}