SPListEventReceiver Class (Microsoft.SharePoint)

Switch on low bandwidth view

Community Content

In this section

Statistics Annotations (0)

Click here to expand

Collapse All

Language Filter

SPListEventReceiver Class (Microsoft.SharePoint)

Provides methods to trap events that occur for lists. This class is never instantiated.

Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in microsoft.sharepoint.dll)

Syntax

Visual Basic (Declaration)

<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel:=True)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel:=True)> _
Public Class SPListEventReceiver
    Inherits SPEventReceiverBase

Visual Basic (Usage)

Dim instance As SPListEventReceiver

[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel=true)] 
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel=true)] 
public class SPListEventReceiver : SPEventReceiverBase

Remarks

The SPListEventReceiver class is not instantiated, but the list event receiver class of a custom event handler must derive from this class and override its methods for the event types that are handled.

The SPListEventReceiver class notifies registered entities of list schema events, supporting list schema operations and the addition or removal of content types.

Like other events, list events come in both Before synchronous and After asynchronous variants. In addition, like other events, list events will generally not occur as the result of a bulk operation. For example, creating a new Windows SharePoint Services list inherently creates a set of fields, but FieldAdding events do not occur.

Inheritance Hierarchy

System.Object
Microsoft.SharePoint.SPEventReceiverBase
Microsoft.SharePoint.SPListEventReceiver

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

SPListEventReceiver Members
Microsoft.SharePoint Namespace