.NET Framework Class Library
CollectionBase..::.OnRemoveComplete Method

Updated: November 2007

Performs additional custom processes after removing an element from the CollectionBase instance.

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

Visual Basic (Declaration)
Protected Overridable Sub OnRemoveComplete ( _
    index As Integer, _
    value As Object _
)
Visual Basic (Usage)
Dim index As Integer
Dim value As Object

Me.OnRemoveComplete(index, value)
C#
protected virtual void OnRemoveComplete(
    int index,
    Object value
)
Visual C++
protected:
virtual void OnRemoveComplete(
    int index, 
    Object^ value
)
J#
protected void OnRemoveComplete(
    int index,
    Object value
)
JScript
protected function OnRemoveComplete(
    index : int, 
    value : Object
)

Parameters

index
Type: System..::.Int32

The zero-based index at which value can be found.

value
Type: System..::.Object

The value of the element to remove from index.

The default implementation of this method is intended to be overridden by a derived class to perform some action after the specified element is removed.

The On* methods are invoked only on the instance returned by the List property, but not on the instance returned by the InnerList property.

The collection reverts back to its previous state if one of the following occurs:

  • The process fails.

  • This method is overridden to throw an exception.

The default implementation of this method is an O(1) operation.

Notes to Implementers:

This method allows implementers to define processes that must be performed after removing the element from the underlying System.Collections..::.ArrayList. By defining this method, implementers can add functionality to inherited methods without having to override all other methods.

OnRemove is invoked before the standard Remove behavior, whereas OnRemoveComplete is invoked after the standard Remove behavior.

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 2.0, 1.0
Page view tracker