List(Of T).Remove Method (T)
Removes the first occurrence of a specific object from the List(Of T).
Assembly: mscorlib (in mscorlib.dll)
Parameters
- item
-
Type:
T
The object to remove from the List(Of T). The value can be null for reference types.
Return Value
Type: System.Booleantrue if item is successfully removed; otherwise, false. This method also returns false if item was not found in the List(Of T).
Implements
ICollection(Of T).Remove(T)If type T implements the IEquatable(Of T) generic interface, the equality comparer is the Equals method of that interface; otherwise, the default equality comparer is Object.Equals.
This method performs a linear search; therefore, this method is an O(n) operation, where n is Count.
The following example demonstrates how to add, remove, and insert a simple business object in a List(Of T).
Imports System.Collections.Generic ' Simple business object. A PartId is used to identify the type of part ' but the part name can change. Public Class Part Implements IEquatable(Of Part) Public Property PartName() As String Get Return m_PartName End Get Set(value As String) m_PartName = Value End Set End Property Private m_PartName As String Public Property PartId() As Integer Get Return m_PartId End Get Set(value As Integer) m_PartId = Value End Set End Property Private m_PartId As Integer Public Overrides Function ToString() As String Return "ID: " & PartId & " Name: " & PartName End Function Public Overrides Function Equals(obj As Object) As Boolean If obj Is Nothing Then Return False End If Dim objAsPart As Part = TryCast(obj, Part) If objAsPart Is Nothing Then Return False Else Return Equals(objAsPart) End If End Function Public Overrides Function GetHashCode() As Integer Return PartId End Function Public Overloads Function Equals(other As Part) As Boolean _ Implements IEquatable(Of Part).Equals If other Is Nothing Then Return False End If Return (Me.PartId.Equals(other.PartId)) End Function ' Should also override == and != operators. End Class Public Class Example Public Shared Sub Main() ' Create a list of parts. Dim parts As New List(Of Part)() ' Add parts to the list. parts.Add(New Part() With { _ .PartName = "crank arm", _ .PartId = 1234 _ }) parts.Add(New Part() With { _ .PartName = "chain ring", _ .PartId = 1334 _ }) parts.Add(New Part() With { _ .PartName = "regular seat", _ .PartId = 1434 _ }) parts.Add(New Part() With { _ .PartName = "banana seat", _ .PartId = 1444 _ }) parts.Add(New Part() With { _ .PartName = "cassette", _ .PartId = 1534 _ }) parts.Add(New Part() With { _ .PartName = "shift lever", _ .PartId = 1634 _ }) ' Write out the parts in the list. This will call the overridden ToString method ' in the Part class. Console.WriteLine() For Each aPart As Part In parts Console.WriteLine(aPart) Next ' Check the list for part #1734. This calls the IEquitable.Equals method ' of the Part class, which checks the PartId for equality. Console.WriteLine(vbLf & "Contains(""1734""): {0}", parts.Contains(New Part() With { _ .PartId = 1734, _ .PartName = "" _ })) ' Insert a new item at position 2. Console.WriteLine(vbLf & "Insert(2, ""1834"")") parts.Insert(2, New Part() With { _ .PartName = "brake lever", _ .PartId = 1834 _ }) 'Console.WriteLine(); For Each aPart As Part In parts Console.WriteLine(aPart) Next Console.WriteLine(vbLf & "Parts[3]: {0}", parts(3)) Console.WriteLine(vbLf & "Remove(""1534"")") ' This will remove part 1534 even though the PartName is different, ' because the Equals method only checks PartId for equality. parts.Remove(New Part() With { _ .PartId = 1534, _ .PartName = "cogs" _ }) Console.WriteLine() For Each aPart As Part In parts Console.WriteLine(aPart) Next Console.WriteLine(vbLf & "RemoveAt(3)") ' This will remove part at index 3. parts.RemoveAt(3) Console.WriteLine() For Each aPart As Part In parts Console.WriteLine(aPart) Next End Sub ' ' This example code produces the following output: ' ID: 1234 Name: crank arm ' ID: 1334 Name: chain ring ' ID: 1434 Name: regular seat ' ID: 1444 Name: banana seat ' ID: 1534 Name: cassette ' ID: 1634 Name: shift lever ' ' Contains("1734"): False ' ' Insert(2, "1834") ' ID: 1234 Name: crank arm ' ID: 1334 Name: chain ring ' ID: 1834 Name: brake lever ' ID: 1434 Name: regular seat ' ID: 1444 Name: banana seat ' ID: 1534 Name: cassette ' ID: 1634 Name: shift lever ' ' Parts[3]: ID: 1434 Name: regular seat ' ' Remove("1534") ' ' ID: 1234 Name: crank arm ' ID: 1334 Name: chain ring ' ID: 1834 Name: brake lever ' ID: 1434 Name: regular seat ' ID: 1444 Name: banana seat ' ID: 1634 Name: shift lever ' ' ' RemoveAt(3) ' ' ID: 1234 Name: crank arm ' ID: 1334 Name: chain ring ' ID: 1834 Name: brake lever ' ID: 1444 Name: banana seat ' ID: 1634 Name: shift lever ' End Class
The following example demonstrates Remove method. Several properties and methods of the List(Of T) generic class are used to add, insert, and search the list. After these operations, the list contains a duplicate. The Remove method is used to remove the first instance of the duplicate item, and the contents are displayed. The Remove method always removes the first instance it encounters.
Imports System Imports System.Collections.Generic Public Class Example Public Shared Sub Main() Dim dinosaurs As New List(Of String) Console.WriteLine(vbLf & "Capacity: {0}", dinosaurs.Capacity) dinosaurs.Add("Tyrannosaurus") dinosaurs.Add("Amargasaurus") dinosaurs.Add("Mamenchisaurus") dinosaurs.Add("Deinonychus") dinosaurs.Add("Compsognathus") Console.WriteLine() For Each dinosaur As String In dinosaurs Console.WriteLine(dinosaur) Next Console.WriteLine(vbLf & "Capacity: {0}", dinosaurs.Capacity) Console.WriteLine("Count: {0}", dinosaurs.Count) Console.WriteLine(vbLf & "Contains(""Deinonychus""): {0}", _ dinosaurs.Contains("Deinonychus")) Console.WriteLine(vbLf & "Insert(2, ""Compsognathus"")") dinosaurs.Insert(2, "Compsognathus") Console.WriteLine() For Each dinosaur As String In dinosaurs Console.WriteLine(dinosaur) Next ' Shows how to access the list using the Item property. Console.WriteLine(vbLf & "dinosaurs(3): {0}", dinosaurs(3)) Console.WriteLine(vbLf & "Remove(""Compsognathus"")") dinosaurs.Remove("Compsognathus") Console.WriteLine() For Each dinosaur As String In dinosaurs Console.WriteLine(dinosaur) Next dinosaurs.TrimExcess() Console.WriteLine(vbLf & "TrimExcess()") Console.WriteLine("Capacity: {0}", dinosaurs.Capacity) Console.WriteLine("Count: {0}", dinosaurs.Count) dinosaurs.Clear() Console.WriteLine(vbLf & "Clear()") Console.WriteLine("Capacity: {0}", dinosaurs.Capacity) Console.WriteLine("Count: {0}", dinosaurs.Count) End Sub End Class ' This code example produces the following output: ' 'Capacity: 0 ' 'Tyrannosaurus 'Amargasaurus 'Mamenchisaurus 'Deinonychus 'Compsognathus ' 'Capacity: 8 'Count: 5 ' 'Contains("Deinonychus"): True ' 'Insert(2, "Compsognathus") ' 'Tyrannosaurus 'Amargasaurus 'Compsognathus 'Mamenchisaurus 'Deinonychus 'Compsognathus ' 'dinosaurs(3): Mamenchisaurus ' 'Remove("Compsognathus") ' 'Tyrannosaurus 'Amargasaurus 'Mamenchisaurus 'Deinonychus 'Compsognathus ' 'TrimExcess() 'Capacity: 5 'Count: 5 ' 'Clear() 'Capacity: 5 'Count: 0
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1