Share via

Catalog of SharePoint Foundation Events

  • Article

Applies to: SharePoint Foundation 2010

Table 1 lists managed types that belong to the SharePoint Foundation 2010 events object model and lists relevant members for each. Types and members that are new in Microsoft SharePoint Foundation 2010 are so indicated. For alternate views of the SharePoint Foundation events object model, see Table of SharePoint Events, Event Receivers, and Event Hosts and Event Receiver Methods Compared: Windows SharePoint Services 3.0 and SharePoint Foundation 2010.

SharePoint Foundation Events Object Model

Table 1. Managed types and members in SharePoint Foundation 2010 events object model

Type

Methods

Properties/Fields

SPContentType

n/a

SPEventReceiverDefinitionCollection EventReceivers

SPEmailEventReceiver

SPEmailEventReceiver()

void EmailReceived (Microsoft.SharePoint.SPList list, Microsoft.SharePoint.Utilities.SPEmailMessage emailMessage, string receiverData)

n/a

SPEventPropertiesBase

protected abstract void MarshalData() (new in 2010)

protected void SetUserTokens(byte[] userTokenBytes) (new in 2010)

protected void SetUserTokens() (new in 2010)

bool Cancel

string ErrorMessage

SPEventReceiverType EventType (new in 2010)

protected SPUserToken EventUserToken (new in 2010)

SPUserToken OriginatingUserToken (new in 2010)

string ReceiverData (new in 2010)

string RedirectUrl (new in 2010)

Guid SiteId (new in 2010)

SPEventReceiverStatus Status

SPEventReceiverBase

SPEventReceiverBase()

protected void DisableEventFiring()

protected void EnableEventFiring()

n/a

SPEventReceiverDefinition

void Delete()

void FireContextEvent (SPSite site)

void Update()

string Assembly

string Class

Guid ContextCollectionId

Guid ContextEventType

Guid ContextId

int ContextItemId

string ContextItemUrl

Guid ContextObjectId

Guid ContextType

int Credential

string Data

Guid HostId

SPEventHostType HostType

Guid Id

string Name

Guid ParentHostId

SPEventHostType ParentHostType

int SequenceNumber

Guid SiteId

string SolutionHash (new in 2010)

SPEventReceiverSynchronization Synchronization (new in 2010)

SPEventReceiverType Type

Guid WebId

SPEventReceiverDefinitionCollection

SPEventReceiverDefinition Add()

SPEventReceiverDefinition Add(Guid Id)

SPEventReceiverDefinition Add(Guid Id, SPList contextList)

SPEventReceiverDefinition Add(Guid Id, SPList contextList)

void Add(SPEventReceiverType receiverType, string assembly, string className)

void CopyTo(SPEventReceiverDefinition[] array, int index)

bool EventReceiverDefinitionExist(Guid eventReceiverId)

int Count

Guid HostId

SPEventHostType HostType

SPEventReceiverDefinition this[Guid eventReceiverId]

SPEventReceiverDefinition this[int index]

int ItemId

SPSite Site

SPWeb Web

SPEventReceiverStatus

n/a

Continue

CancelNoError

CancelWithError

CancelWithRedirectUrl (new in 2010)

SPEventReceiverSynchronization

(new in 2010)

n/a

Default (new in 2010)

Synchronous (new in 2010)

Asynchronous (new in 2010)

SPEventReceiverType

n/a

ContextEvent

EmailReceived

FieldAdded

FieldAdding

FieldDeleted

FieldDeleting

FieldUpdated

FieldUpdating

InvalidReceiver

ItemAdded

ItemAdding

ItemAttachmentAdded

ItemAttachmentAdding

ItemAttachmentDeleted

ItemAttachmentDeleting

ItemCheckedIn

ItemCheckedOut

ItemCheckingIn

ItemCheckingOut

ItemDeleted

ItemDeleting

ItemFileConverted

ItemFileMoved

ItemFileMoving

ItemUncheckedOut

ItemUncheckingOut

ItemUpdated

ItemUpdating

ListAdded (new in 2010)

ListAdding (new in 2010)

ListDeleted (new in 2010)

ListDeleting (new in 2010)

SiteDeleted

SiteDeleting

WebAdding (new in 2010)

WebDeleted

WebDeleting

WebMoved

WebMoving

WebProvisioned (new in 2010)

WorkflowCompleted (new in 2010)

WorkflowPostponed (new in 2010)

WorkflowStarted (new in 2010)

WorkflowStarting (new in 2010)

SPFile

n/a

SPEventReceiverDefinitionCollection EventReceivers

SPItemEventProperties

void Dispose()

SPListItem GetListItemFields(string field1, params string[] fields) (new in 2010)

void InvalidateListItem() (new in 2010)

void InvalidateWeb() (new in 2010)

protected override void MarshalData() (new in 2010)

SPWeb OpenWeb()

SPItemEventDataCollection AfterProperties

string AfterUrl

SPItemEventDataCollection BeforeProperties

string BeforeUrl

SPEventContext Context

int CurrentUserId

SPList List (new in 2010)

Guid ListId

SPListItem ListItem

int ListItemId

string ListTitle

string RelativeWebUrl

string UserDisplayName

string UserLoginName

SPWeb Web (new in 2010)

bool Versionless

string WebUrl

SPUrlZone Zone

SPEventReceiverType EventType (inherits from parent in 2010)

Guid SiteId (inherits from parent in 2010)

SPItemEventReceiver

SPItemEventReceiver()

void ContextEvent(SPItemEventProperties properties)

void ItemAdded(SPItemEventProperties properties)

void ItemAdding(SPItemEventProperties properties)

void ItemAttachmentAdded(SPItemEventProperties properties)

void ItemAttachmentAdding(SPItemEventProperties properties)

void ItemAttachmentDeleted(SPItemEventProperties properties)

void ItemAttachmentDeleting(SPItemEventProperties properties)

void ItemCheckedIn(SPItemEventProperties properties)

void ItemCheckedOut(SPItemEventProperties properties)

void ItemCheckingIn(SPItemEventProperties properties)

void ItemCheckingOut(SPItemEventProperties properties)

void ItemDeleted(SPItemEventProperties properties)

void ItemDeleting(SPItemEventProperties properties)

void ItemFileConverted(SPItemEventProperties properties)

void ItemFileMoved(SPItemEventProperties properties)

void ItemFileMoving(SPItemEventProperties properties)

void ItemUncheckedOut(SPItemEventProperties properties)

void ItemUncheckingOut(SPItemEventProperties properties)

void ItemUpdated(SPItemEventProperties properties)

void ItemUpdating(SPItemEventProperties properties)

n/a

SPList

n/a

SPEventReceiverDefinitionCollection EventReceivers

SPListEventProperties

void Dispose()

void InvalidateList()

void InvalidateWeb()

protected override void MarshalData()

Guid FeatureId (new in 2010)

SPField Field

string FieldName

string FieldXml

SPList List

Guid ListId

string ListTitle

int TemplateId (new in 2010)

string UserDisplayName

string UserLoginName

SPWeb Web

Guid WebId

string WebUrl

SPItemEventDataCollection AfterProperties

SPEventReceiverType EventType (inherited from parent in 2010)

Guid SiteId (inherited from parent in 2010)

SPListEventReceiver

SPListEventReceiver()

void FieldAdded(SPListEventProperties properties)

void FieldAdding(SPListEventProperties properties)

void FieldDeleted(SPListEventProperties properties)

void FieldDeleting(SPListEventProperties properties)

void FieldUpdated(SPListEventProperties properties)

void FieldUpdating(SPListEventProperties properties)

void ListAdded(SPListEventProperties properties) (new in 2010)

void ListAdding(SPListEventProperties properties) (new in 2010)

void ListDeleted(SPListEventProperties properties) (new in 2010)

void ListDeleting(SPListEventProperties properties) (new in 2010)

n/a

SPListEventType

Note: This type has been marked "obsolete" in Microsoft SharePoint Foundation 2010.

n/a

n/a

SPSite

n/a

SPEventReceiverDefinitionCollection EventReceivers (new for 2010)

SPWeb

n/a

SPEventReceiverDefinitionCollection EventReceivers

SPWebEventProperties

void Dispose() (new in 2010)

void InvalidateWeb() (new in 2010)

protected override void MarshalData() (new in 2010)

string FullUrl

string NewServerRelativeUrl

Guid ParentWebId (new in 2010)

string ServerRelativeUrl

string UserDisplayName

string UserLoginName

SPWeb Web

Guid WebId

SPEventReceiverType EventType (inherited from parent in 2010)

Guid SiteId (inherited from parent in 2010)

SPWebEventReceiver

SPWebEventReceiver()

void SiteDeleted(SPWebEventProperties properties)

void SiteDeleting(SPWebEventProperties properties)

void WebAdding(SPWebEventProperties properties) (new in 2010)

void WebDeleted(SPWebEventProperties properties)

void WebDeleting(SPWebEventProperties properties)

void WebMoved(SPWebEventProperties properties)

void WebMoving(SPWebEventProperties properties)

void WebProvisioned(SPWebEventProperties properties) (new in 2010)

n/a

SPWorkflowEventProperties

(This type is new in 2010)

protected override void MarshalData() (new in 2010)

SPWorkflowActivationProperties ActivationProperties (new in 2010)

string AssociationData (new in 2010)

SPWorkflowEventCompletionType CompletionType (new in 2010)

Exception ErrorException (new in 2010)

SPEventReceiverType EventType (new in 2010)

string InitiationData (new in 2010)

SPWorkflowPostponedEventType PostponedEvent (new in 2010)

int TerminatedByUserId (new in 2010)

SPWorkflow Workflow (new in 2010)

StopEventReceiver

StopEventReceiver()

protected bool Stopped

Strings

n/a

EventPropertiesCannotBeChanged

EventReceiverAssemblyNameNull

EventReceiverAssemblyNotInGAC

EventReceiverAsyncBeforeInvalid (new in 2010)

EventReceiverCancelRequest

EventReceiverClassNameNull

EventReceiverTypeInvalid

EventReceiverWorkflowContextInvalid

InvalidEventReceiverHostType

See Also

Concepts

Table of SharePoint Events, Event Receivers, and Event Hosts

Event Receiver Methods Compared: Windows SharePoint Services 3.0 and SharePoint Foundation 2010

Other Resources

Events in SharePoint Foundation 2010