This topic has not yet been rated - Rate this topic

SPEventPropertiesBase Class

SharePoint 2010

Windows SharePoint Services 3

Abstract base class that provides the event properties that are common to all event types. This class is never instantiated.

Inheritance Hierarchy

System.Object
  Microsoft.SharePoint.SPEventPropertiesBase
    Microsoft.SharePoint.SPItemEventProperties
    Microsoft.SharePoint.SPListEventProperties
    Microsoft.SharePoint.SPWebEventProperties
    Microsoft.SharePoint.Workflow.SPWorkflowEventProperties

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

Syntax

Copy

[SerializableAttribute]
[SubsetCallableTypeAttribute]
public abstract class SPEventPropertiesBase

Remarks

The SPEventPropertiesBase class is not instantiated but provides methods for classes deriving from it that are listed in the Inheritance Hierarchy section below.

Examples

The following example of an event handler method overrides the ItemDeleting() method and uses inherited properties of the SPEventPropertiesBase class to cancel an event and display an error message.

Copy

public override void ItemDeleting(SPItemEventProperties properties)
{
    properties.Status = SPEventReceiverStatus.CancelWithError;
    properties.ErrorMessage = "Deleting items is not supported.";
}

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

SPEventPropertiesBase Members

Microsoft.SharePoint Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ