CollectionBase.OnClear メソッド

.NET Framework クラス ライブラリ リファレンス

CollectionBase.OnClear メソッド

CollectionBase インスタンスの内容を消去するときに、追加のカスタム プロセスを実行します。

名前空間: System.Collections
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Protected Overridable Sub
 OnClear

Visual Basic (使用法)

Me.OnClear

C#

protected virtual void OnClear ()

C++

protected:
virtual void OnClear ()

J#

protected void OnClear ()

JScript

protected function OnClear ()

解説

このメソッドの既定の実装は、コレクションの消去前にアクションを実行するために、派生クラスによってオーバーライドされます。

On* メソッドは、List プロパティによって返されたインスタンスに対してだけ呼び出され、InnerList プロパティによって返されたインスタンスに対しては呼び出されません。

プロセスが失敗した場合、コレクションは以前の状態に戻ります。

このメソッドの既定の実装は O(1) 操作です。

実装時の注意 このメソッドを使用すると、基になる System.Collections.ArrayList からすべての要素を削除する前に実行する必要があるプロセスを定義できます。このメソッドを定義すると、他のすべてのメソッドをオーバーライドしなくても、継承されたメソッドに機能を追加できます。 OnClear は標準の Clear 操作の前に呼び出され、OnClearComplete は標準の Clear 操作の後に呼び出されます。 たとえば、グローバルな Clear 操作で削除を実行する場合、特定の要素だけを削除せずに残すことができます。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
CollectionBase クラス
CollectionBase メンバ
System.Collections 名前空間
OnClearComplete
OnRemove