IListEventSink.OnEvent Method

NOTE: This API is now obsolete.

Responds to changes that occur to a document in a document library.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<ObsoleteAttribute("Use V3 style events")> _
Sub OnEvent ( _
    listEvent As SPListEvent _
)
'Usage
Dim instance As IListEventSink
Dim listEvent As SPListEvent

instance.OnEvent(listEvent)
[ObsoleteAttribute("Use V3 style events")]
void OnEvent(
    SPListEvent listEvent
)

Parameters

Remarks

The OnEvent method responds to one of the following types of changes to a document in a document library:

  • Checked in

  • Checked out

  • Check out cancelled

  • Copied

  • Deleted

  • Edited

  • Moved

  • Renamed

  • Uploaded

SharePoint Foundation throws an exception and logs an error if the assembly for an event handler cannot be found, if the class defining an event handler cannot be found, or if for any other reason the event handler cannot be instantiated.

For an example that applies to this method, see Walkthrough: Handling Document Library Events.

See Also

Reference

IListEventSink Interface

IListEventSink Members

Microsoft.SharePoint Namespace