Export (0) Print
Expand All

SortedList.Clear Method

Removes all elements from a SortedList object.

Namespace:  System.Collections
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public Overridable Sub Clear

Implements

IDictionary.Clear

ExceptionCondition
NotSupportedException

The SortedList object is read-only.

-or-

The SortedList has a fixed size.

Count is set to zero and references to other objects from elements of the collection are also released.

Capacity remains unchanged. To reset the capacity of the SortedList object, call TrimToSize or set the Capacity property directly. Trimming an empty SortedList sets the capacity of the SortedList to the default capacity.

This method is an O(n) operation, where n is Count.

The following code example shows how to trim the unused portions of a SortedList object and how to clear the values of the SortedList.

Imports System
Imports System.Collections
Imports Microsoft.VisualBasic

Public Class SamplesSortedList    

    Public Shared Sub Main()

        ' Creates and initializes a new SortedList. 
        Dim mySL As New SortedList()
        mySL.Add("one", "The")
        mySL.Add("two", "quick")
        mySL.Add("three", "brown")
        mySL.Add("four", "fox")
        mySL.Add("five", "jumped")

        ' Displays the count, capacity and values of the SortedList.
        Console.WriteLine("Initially,")
        Console.WriteLine("   Count    : {0}", mySL.Count)
        Console.WriteLine("   Capacity : {0}", mySL.Capacity)
        Console.WriteLine("   Values:")
        PrintKeysAndValues(mySL)

        ' Trims the SortedList.
        mySL.TrimToSize()

        ' Displays the count, capacity and values of the SortedList.
        Console.WriteLine("After TrimToSize,")
        Console.WriteLine("   Count    : {0}", mySL.Count)
        Console.WriteLine("   Capacity : {0}", mySL.Capacity)
        Console.WriteLine("   Values:")
        PrintKeysAndValues(mySL)

        ' Clears the SortedList.
        mySL.Clear()

        ' Displays the count, capacity and values of the SortedList.
        Console.WriteLine("After Clear,")
        Console.WriteLine("   Count    : {0}", mySL.Count)
        Console.WriteLine("   Capacity : {0}", mySL.Capacity)
        Console.WriteLine("   Values:")
        PrintKeysAndValues(mySL)

        ' Trims the SortedList again.
        mySL.TrimToSize()

        ' Displays the count, capacity and values of the SortedList.
        Console.WriteLine("After the second TrimToSize,")
        Console.WriteLine("   Count    : {0}", mySL.Count)
        Console.WriteLine("   Capacity : {0}", mySL.Capacity)
        Console.WriteLine("   Values:")
        PrintKeysAndValues(mySL)
    End Sub    


    Public Shared Sub PrintKeysAndValues(myList As SortedList)
        Console.WriteLine(ControlChars.Tab & "-KEY-" & ControlChars.Tab & _
           "-VALUE-")
        Dim i As Integer 
        For i = 0 To myList.Count - 1
            Console.WriteLine(ControlChars.Tab & "{0}:" & ControlChars.Tab & _
               "{1}", myList.GetKey(i), myList.GetByIndex(i))
        Next i
        Console.WriteLine()
    End Sub 
End Class 

' This code produces the following output. 
'  
' Initially, 
'    Count    : 5 
'    Capacity : 16 
'    Values: 
'     -KEY-    -VALUE- 
'     five:    jumped 
'     four:    fox 
'     one:    The 
'     three:    brown 
'     two:    quick 

' After TrimToSize, 
'    Count    : 5 
'    Capacity : 5 
'    Values: 
'     -KEY-    -VALUE- 
'     five:    jumped 
'     four:    fox 
'     one:    The 
'     three:    brown 
'     two:    quick 
'  
' After Clear, 
'    Count    : 0 
'    Capacity : 16 
'    Values: 
'     -KEY-    -VALUE- 
' 
'
' After the second TrimToSize, 
'    Count    : 0 
'    Capacity : 16 
'    Values: 
'     -KEY-    -VALUE-
 

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show:
© 2015 Microsoft