Export (0) Print
Expand All

ListBox.Sort Method

Sorts the items in the ListBox.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

'Declaration
Protected Overridable Sub Sort
'Usage

Me.Sort
protected void Sort ()
protected function Sort ()
Not applicable.

Sort forces the collection to add each item back to itself if the Sorted property is true. Each item is then inserted into the correct position.

Notes to Inheritors: You can override this method in your derived class to provide your own sorting routine. Access the results of the overridden Sort method by setting the Sorted property to true. When adding items to a ListBox, it is more efficient to sort the items first and then add new items.

The following code example demonstrates using the Sort method. The example demonstrates inheriting from the ListBox class and overriding the Sort method in the derived class to perform a user-defined sort. To run this example paste the following code in an empty form.


Imports System.Drawing
Imports System.Windows.Forms

Public Class Form1
    Inherits System.Windows.Forms.Form

    Public Sub New()
        MyBase.New()
        Me.Button1 = New System.Windows.Forms.Button
        Me.SortByLengthListBox1 = New SortByLengthListBox
        Me.SuspendLayout()
        Me.Button1.Location = New System.Drawing.Point(64, 16)
        Me.Button1.Name = "Button1"
        Me.Button1.Size = New System.Drawing.Size(176, 23)
        Me.Button1.TabIndex = 0
        Me.Button1.Text = "Click me for list sorted by length"
        Me.SortByLengthListBox1.Items.AddRange(New Object() {"System", _
            "System.Windows.Forms", "System.Xml", _
            "System.Net", "System.Drawing", "System.IO"})
        Me.SortByLengthListBox1.Location = New System.Drawing.Point(72, 48)
        Me.SortByLengthListBox1.Name = "SortByLengthListBox1"
        Me.SortByLengthListBox1.Size = New System.Drawing.Size(120, 95)
        Me.SortByLengthListBox1.TabIndex = 1
        Me.ClientSize = New System.Drawing.Size(292, 266)
        Me.Controls.Add(Me.SortByLengthListBox1)
        Me.Controls.Add(Me.Button1)
        Me.Name = "Form1"
        Me.Text = "Sort Example"
        Me.ResumeLayout(False)

    End Sub

    Friend WithEvents Button1 As System.Windows.Forms.Button
    Friend WithEvents SortByLengthListBox1 As SortByLengthListBox

    Public Shared Sub Main()
        Application.Run(New Form1)
    End Sub

    
    Private Sub Button1_Click(ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button1.Click

        ' Set the Sorted property to True to raise the overridden Sort
        ' method.
        SortByLengthListBox1.Sorted = True
    End Sub
End Class

' This class inherits from ListBox and implements a different 
' sorting method. Sort will be called by setting the class's Sorted
' property to True.
Public Class SortByLengthListBox
    Inherits ListBox

    Public Sub New()
        MyBase.New()
    End Sub

    ' Overrides the parent class Sort to perform a simple
    ' bubble sort on the length of the string contained in each item.
    Protected Overrides Sub Sort()
        If (Items.Count > 1) Then

            Dim swapped As Boolean

            Do
                Dim counter As Integer = Items.Count - 1
                swapped = False
                While (counter - 1 > 0)

                    ' Compare the items' length.
                    If Items(counter).ToString.Length < _
                       Items(counter - 1).ToString.Length Then

                        ' If true, swap the items.
                        Dim temp As Object = Items(counter)
                        Items(counter) = Items(counter - 1)
                        Items(counter - 1) = temp
                        swapped = True

                    End If
                    ' Decrement the counter.
                    counter -= 1
                End While
            Loop While (swapped = True)
        End If
    End Sub

End Class

// The following code example demonstrates using the ListBox.Sort method
// by inheriting from the ListBox class and overriding the Sort method.
import System.Drawing.*;
import System.Windows.Forms.*;

public class Form1 extends System.Windows.Forms.Form
{
    private System.Windows.Forms.Button button1;
    private SortByLengthListBox sortingBox;

    public Form1()
    {
        this.button1 = new System.Windows.Forms.Button();
        this.sortingBox = new SortByLengthListBox();
        this.SuspendLayout();
        this.button1.set_Location(new System.Drawing.Point(64, 16));
        this.button1.set_Name("Button1");
        this.button1.set_Size(new System.Drawing.Size(176, 23));
        this.button1.set_TabIndex(0);
        this.button1.set_Text("Click me for list sorted by length");
        this.button1.add_Click(new System.EventHandler(button1_Click));
        this.sortingBox.get_Items().AddRange(new Object[] { "System", 
            "System.Windows.Forms", "System.Xml", "System.Net", 
            "System.Drawing", "System.IO" });
        this.sortingBox.set_Location(new System.Drawing.Point(72, 48));
        this.sortingBox.set_Size(new System.Drawing.Size(120, 95));
        this.sortingBox.set_TabIndex(1);
        this.set_ClientSize(new System.Drawing.Size(292, 266));
        this.get_Controls().Add(this.sortingBox);
        this.get_Controls().Add(this.button1);
        this.set_Name("Form1");
        this.set_Text("Sort Example");
        this.ResumeLayout(false);
    } //Form1

    public static void main(String[] args)
    {
        Application.Run(new Form1());
    } //main

    private void button1_Click(Object sender, System.EventArgs e)
    {
        // Set the Sorted property to True to raise the overridden Sort
        // method.
        sortingBox.set_Sorted(true);
    } //button1_Click
} //Form1

// This class inherits from ListBox and implements a different 
// sorting method. Sort will be called by setting the class's Sorted
// property to True.
public class SortByLengthListBox extends ListBox
{
    public SortByLengthListBox()
    {
        super();
    } //SortByLengthListBox

    // Overrides the parent class Sort to perform a simple
    // bubble sort on the length of the string contained in each item.
    protected void Sort()
    {
        if (get_Items().get_Count() > 1) {
            boolean swapped;
            do {
                int counter = get_Items().get_Count() - 1;
                swapped = false;

                while (counter - 1 > 0) {
                    // Compare the items' length. 
                    if (get_Items().get_Item(counter).ToString().get_Length() 
                        < get_Items().get_Item((counter - 1)).
                        ToString().get_Length()) {
                        // Swap the items.
                        Object temp = get_Items().get_Item(counter);
                        get_Items().set_Item(counter, get_Items().
                            get_Item((counter - 1)));
                        get_Items().set_Item((counter - 1), temp);
                        swapped = true;
                    }
                    // Decrement the counter.
                    counter -= 1;
                }
            } while (swapped == true);
        }
    } //Sort
} //SortByLengthListBox

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft