SPItemEventProperties members

Contains information about list item events.

The SPItemEventProperties type exposes the following members.

Properties

  Name Description
Public property AfterProperties Gets a hash table of properties consisting of string/value pairs that correspond to fields in the SPItem object after the event occurred.
Public property AfterUrl Gets the URL of the item after the event occurred.
Public property BeforeProperties Gets a hash table of properties consisting of string/value pairs that correspond to fields in the SPItem object before the event occurred.
Public property BeforeUrl Gets the URL of the item before the event occurred.
Public property Cancel Obsolete. Gets or sets a Boolean value that indicates whether to cancel the event. (Inherited from SPEventPropertiesBase.)
Public property Context Gets the context of the item event.
Public property CurrentUserId Gets the integer ID of the user whose action caused the event to occur.
Public property ErrorMessage Gets or sets the error message that Microsoft SharePoint Foundation displays when an event is cancelled. (Inherited from SPEventPropertiesBase.)
Public property EventType Gets the type of the event. (Inherited from SPEventPropertiesBase.)
Protected property EventUserToken Represents the current user at the time the specified event is fired. (Inherited from SPEventPropertiesBase.)
Public property ExternalNotificationMessage Gets the notification message received from the external system.
Public property FileSystemObjectTypePropertyName Gets a string that contains the file system object type.
Public property IsBackgroundSave Gets a Boolean value that indicates whether the current update operation was triggered by a non-user gesture like a background thread or automated save.
Public property List Gets the list that is associated with the event that occurred.
Public property ListId Gets the ID of the list that is associated with the event that occurred.
Public property ListItem Gets the list item that is associated with the event that occurred.
Public property ListItemId Gets the ID of the list item associated with the event.
Public property ListItemUniqueId Gets the list item unique ID of the event.
Public property ListItemVersion Gets the specific historical version of the list item for which the event applies.
Public property ListItemVersionType Gets the type of historical version of the list item for which the event applies.
Public property ListTitle Gets the title of the list associated with the event that occurred.
Public property OriginatingUserToken Gets the token of the user who makes the request. (Inherited from SPEventPropertiesBase.)
Public property ReceiverData Gets a string that contains data about the event. (Inherited from SPEventPropertiesBase.)
Public property RedirectUrl Obsolete. A URL to redirect to when the status of SPEventReceiverStatus is CancelWithRedirectUrl. (Inherited from SPEventPropertiesBase.)
Public property RelativeWebUrl Gets the server-relative URL of the Web site that is associated with the event that occurred.
Public property Site Gets the site collection for the list item.
Public property SiteId Gets the site ID of the event. (Inherited from SPEventPropertiesBase.)
Public property Status Gets or sets the status of trapping the event. (Inherited from SPEventPropertiesBase.)
Public property UserDisplayName Gets the display name of the user whose action caused the event to occur.
Public property UserLoginName Gets the user name of the user whose action caused the event to occur.
Public property Versionless Indicates whether the event results in a change that does not increment the version.
Public property Web Gets the parent Web site of the list associated with the event that occurred.
Public property WebUrl Gets the absolute URL of the Web site associated with the event that occurred.
Public property Zone Gets the zone of the website that is associated with the event that occurred.

Top

Methods

  Name Description
Public method Dispose Releases all unmanaged resources used by the site collection object associated with the event.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method InvalidateListItem Invalidates the current ListItem object.
Public method InvalidateWeb Invalidates the current SPWeb object.
Protected method MemberwiseClone (Inherited from Object.)
Public method OpenSite Opens the site collection of the Web application in which the event is triggered.
Public method OpenWeb Retrieves the Web site that is associated with the event that occurred.
Public method SetDoNotTrimVersions Sets the item event property to disable version trimming.
Public method SetForceCreateDocumentVersion Sets the item event property to force-create a version with this update of a file in a document library.
Public method ToString (Inherited from Object.)

Top

See also

Reference

SPItemEventProperties class

Microsoft.SharePoint namespace