CollectionBase.OnSetComplete Method (System.Collections)

Microsoft Developer Network

OnSetComplete Method

.NET Framework Class Library

CollectionBase..::.OnSetComplete Method

Performs additional custom processes after setting a value in the CollectionBase instance.

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

Syntax

Visual Basic (Declaration)

Protected Overridable Sub OnSetComplete ( _
    index As Integer, _
    oldValue As Object, _
    newValue As Object _
)

Visual Basic (Usage)

Dim index As Integer
Dim oldValue As Object
Dim newValue As Object

Me.OnSetComplete(index, oldValue, _
    newValue)

protected virtual void OnSetComplete(
    int index,
    Object oldValue,
    Object newValue
)

Visual C++

protected:
virtual void OnSetComplete(
    int index, 
    Object^ oldValue, 
    Object^ newValue
)

JScript

protected function OnSetComplete(
    index : int, 
    oldValue : Object, 
    newValue : Object
)

Parameters

index: Type: System..::.Int32
The zero-based index at which oldValue can be found.

oldValue: Type: System..::.Object
The value to replace with newValue.

newValue: Type: System..::.Object
The new value of the element at index.

Remarks

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

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 setting the specified element in the underlying System.Collections..::.ArrayList. By defining this method, implementers can add functionality to inherited methods without having to override all other methods.

OnSet is invoked before the standard Set behavior, whereas OnSetComplete is invoked after the standard Set behavior.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, 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, Zune

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.

Version Information

.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: 3.0, 2.0, 1.0

Reference

CollectionBase Class

CollectionBase Members

System.Collections Namespace

OnSet

OnInsertComplete