Usar o Visual C# para classificar um controle ListView usando uma coluna

Este artigo fornece informações sobre como classificar um controle ListView usando uma coluna no Visual C# e também fornece um exemplo de código para explicar os métodos.

Versão original do produto: Visual C#
Número de KB original: 319401

Resumo

Quando você estiver trabalhando com o controle ListView, talvez queira classificar seu conteúdo com base em uma coluna específica. Um exemplo desse tipo de funcionalidade ocorre em um programa do Windows Explorer ao exibir o conteúdo de uma pasta em seu disco rígido. Na exibição Detalhes, o Windows Explorer exibe informações sobre os arquivos nessa pasta. Por exemplo, você vê o nome do arquivo, o tamanho do arquivo, o tipo de arquivo e a data em que o arquivo foi modificado. Quando você clica em um dos cabeçalhos de coluna, a lista é classificada em ordem crescente com base nessa coluna. Quando você clica no mesmo cabeçalho de coluna novamente, a coluna é classificada em ordem decrescente.

O exemplo neste artigo define uma classe que herda da IComparer interface. Além disso, este exemplo usa o Compare método da CaseInsenstiveComparer classe para executar a comparação real dos itens.

Observação

  • Esse método de comparação não é sensível a casos.
  • Todas as colunas neste exemplo são classificadas de forma de texto .

Se você quiser classificar de uma maneira diferente (como numericamente), poderá substituir a seguinte linha de código por qualquer abordagem de classificação que você deseja usar:

ObjectCompare.Compare(listviewX.SubItems[ColumnToSort].Text,listviewY.SubItems[ColumnToSort].Text);

Etapas para criar o projeto de exemplo

  1. Crie um novo projeto de aplicativo Do Windows do Visual C#. O Form1 é criado por padrão.

  2. Adicione um controle ListView ao Form1. Dimensione o formulário para ter vários centímetros de largura por vários centímetros de altura.

  3. Cole o seguinte código na classe para o formulário:

    private ListViewColumnSorter lvwColumnSorter;
    
  4. Cole o seguinte código no construtor para o formulário, após a chamada para o InitializeComponent método:

    // Create an instance of a ListView column sorter and assign it
    // to the ListView control.
    lvwColumnSorter = new ListViewColumnSorter();
    this.listView1.ListViewItemSorter = lvwColumnSorter;
    
  5. Cole o seguinte código no Load evento para o formulário:

    ColumnHeader columnheader;// Used for creating column headers.
    ListViewItem listviewitem;// Used for creating listview items.
    
    // Ensure that the view is set to show details.
    listView1.View = View.Details;
    
    // Create some listview items consisting of first and last names.
    listviewitem = new ListViewItem("John");
    listviewitem.SubItems.Add("Smith");
    this.listView1.Items.Add(listviewitem);
    
    listviewitem = new ListViewItem("Bob");
    listviewitem.SubItems.Add("Taylor");
    this.listView1.Items.Add(listviewitem);
    
    listviewitem = new ListViewItem("Kim");
    listviewitem.SubItems.Add("Zimmerman");
    this.listView1.Items.Add(listviewitem);
    
    listviewitem = new ListViewItem("Olivia");
    listviewitem.SubItems.Add("Johnson");
    this.listView1.Items.Add(listviewitem);
    
    // Create some column headers for the data.
    columnheader = new ColumnHeader();
    columnheader.Text = "First Name";
    this.listView1.Columns.Add(columnheader);
    
    columnheader = new ColumnHeader();
    columnheader.Text = "Last Name";
    this.listView1.Columns.Add(columnheader);
    
    // Loop through and size each column header to fit the column header text.
    foreach (ColumnHeader ch in this.listView1.Columns)
    {
        ch.Width = -2;
    }
    

    Observação

    O código deve ser alterado no Visual Studio. Quando você cria um projeto Windows Forms, o Visual C# adiciona um formulário ao projeto por padrão. Esse formulário se chama Form1. Os dois arquivos que representam o formulário são nomeados Form1.cs e Form1.designer.cs. Você grava seu código em Form1.cs. O arquivo Designer.cs é onde o Windows Forms Designer grava o código que implementa todas as ações executadas adicionando controles. Para obter mais informações sobre o Windows Forms Designer no Visual C#, visite Criando um projeto (Visual C#).

  6. Cole o seguinte código no ColumnClick evento para o controle ListView:

    // Determine if clicked column is already the column that is being sorted.
    if (e.Column == lvwColumnSorter.SortColumn)
    {
        // Reverse the current sort direction for this column.
        if (lvwColumnSorter.Order == SortOrder.Ascending)
        {
            lvwColumnSorter.Order = SortOrder.Descending;
        }
        else
        {
            lvwColumnSorter.Order = SortOrder.Ascending;
        }
    }
    else
    {
        // Set the column number that is to be sorted; default to ascending.
        lvwColumnSorter.SortColumn = e.Column;
        lvwColumnSorter.Order = SortOrder.Ascending;
    }
    
    // Perform the sort with these new sort options.
    this.listView1.Sort();
    
  7. No menu Projeto , clique em Adicionar Classe para adicionar uma nova classe ao projeto.

  8. Substitua todo o código padrão na nova classe pelo seguinte código:

    using System.Collections;
    using System.Windows.Forms;
    
    /// <summary>
    /// This class is an implementation of the 'IComparer' interface.
    /// </summary>
    public class ListViewColumnSorter : IComparer
    {
        /// <summary>
        /// Specifies the column to be sorted
        /// </summary>
        private int ColumnToSort;
    
        /// <summary>
        /// Specifies the order in which to sort (i.e. 'Ascending').
        /// </summary>
        private SortOrder OrderOfSort;
    
        /// <summary>
        /// Case insensitive comparer object
        /// </summary>
        private CaseInsensitiveComparer ObjectCompare;
    
        /// <summary>
        /// Class constructor. Initializes various elements
        /// </summary>
        public ListViewColumnSorter()
        {
            // Initialize the column to '0'
            ColumnToSort = 0;
    
            // Initialize the sort order to 'none'
            OrderOfSort = SortOrder.None;
    
            // Initialize the CaseInsensitiveComparer object
            ObjectCompare = new CaseInsensitiveComparer();
        }
    
        /// <summary>
        /// This method is inherited from the IComparer interface. It compares the two objects passed using a case insensitive comparison.
        /// </summary>
        /// <param name="x">First object to be compared</param>
        /// <param name="y">Second object to be compared</param>
        /// <returns>The result of the comparison. "0" if equal, negative if 'x' is less than 'y' and positive if 'x' is greater than 'y'</returns>
        public int Compare(object x, object y)
        {
            int compareResult;
            ListViewItem listviewX, listviewY;
    
            // Cast the objects to be compared to ListViewItem objects
            listviewX = (ListViewItem)x;
            listviewY = (ListViewItem)y;
    
            // Compare the two items
            compareResult = ObjectCompare.Compare(listviewX.SubItems[ColumnToSort].Text,listviewY.SubItems[ColumnToSort].Text);
    
            // Calculate correct return value based on object comparison
            if (OrderOfSort == SortOrder.Ascending)
            {
                // Ascending sort is selected, return normal result of compare operation
                return compareResult;
            }
            else if (OrderOfSort == SortOrder.Descending)
            {
                // Descending sort is selected, return negative result of compare operation
                return (-compareResult);
            }
            else
            {
                // Return '0' to indicate they are equal
                return 0;
            }
        }
    
        /// <summary>
        /// Gets or sets the number of the column to which to apply the sorting operation (Defaults to '0').
        /// </summary>
        public int SortColumn
        {
            set
            {
                ColumnToSort = value;
            }
            get
            {
                return ColumnToSort;
            }
        }
    
        /// <summary>
        /// Gets or sets the order of sorting to apply (for example, 'Ascending' or 'Descending').
        /// </summary>
        public SortOrder Order
        {
            set
            {
                OrderOfSort = value;
            }
            get
            {
                return OrderOfSort;
            }
        }
    
    }
    
  9. Salve, crie e execute o projeto de exemplo.

  10. Clique nos vários cabeçalhos de coluna no controle ListView. Quando você clica no cabeçalho, o conteúdo do controle ListView é classificado em ordem crescente com base na coluna clicada. Quando você clica no mesmo cabeçalho de coluna novamente, essa coluna é classificada em ordem decrescente.