[This is preliminary documentation and is subject to change.]

Raises Clearing event

Namespace: Tools.CollectionsT.GenericT
Assembly: Tools (in Tools.dll) Version: 1.5.3.38916 (1.5.3.38916)

Syntax

C#
protected virtual void OnClearing(
	CancelMessageEventArgs e
)
Visual Basic
Protected Overridable Sub OnClearing ( _
	e As CancelMessageEventArgs _
)
Visual C++
protected:
virtual void OnClearing(
	CancelMessageEventArgs^ e
)
F#
abstract OnClearing : 
        e:CancelMessageEventArgs -> unit 
override OnClearing : 
        e:CancelMessageEventArgs -> unit
JScript
protected function OnClearing(
	e : CancelMessageEventArgs
)

Remarks

Note for inheritors: Always call base class method OnClearing(CancelMessageEventArgs) in order the event to be raised

Exceptions

ExceptionCondition
System..::..OperationCanceledExceptionOperation is canceled in eventhandler and CancelError is true
System..::..ExceptionAny Exception can be thrown by event handler of the Clearing event -or- Any exception may be thrown by OnClearing(ICollection) when AllowItemCancel is true

See Also