SPListEventProperties Members
Include Protected Members
Include Inherited Members
Provides properties for SharePoint list events.
The SPListEventProperties type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Cancel | Gets or sets a Boolean value that indicates whether to cancel the event. (Inherited from SPEventPropertiesBase.) |
|
ErrorMessage | Gets or sets the error message that Microsoft SharePoint Foundation displays when an event is cancelled. (Inherited from SPEventPropertiesBase.) |
|
EventType | Gets the type of the event. (Inherited from SPEventPropertiesBase.) |
.gif "Protected property") |
EventUserToken | Represents the current user at the time the specified event is fired. (Inherited from SPEventPropertiesBase.) |
|
FeatureId | Gets the unique identifier of the SharePoint feature that created the list. |
|
Field | Gets the field that is affected by adding, removing, or updating a field in the list. |
|
FieldName | Gets the name of the field that is affected by adding, removing, or updating a field in the list. |
|
FieldXml | Gets the XML definition of the field that is affected by adding, removing, or updating a field in the list. |
|
List | Gets a reference to the list that is affected by the event. |
|
ListId | Gets the GUID of the list affected by the event. |
|
ListTitle | Gets the title of the list that is affected by the event. |
|
OriginatingUserToken | Gets the token of the user who makes the request. (Inherited from SPEventPropertiesBase.) |
|
ReceiverData | Gets a string that contains data about the event. (Inherited from SPEventPropertiesBase.) |
|
RedirectUrl | A URL to redirect to when the status of SPEventReceiverStatus is CancelWithRedirectUrl. (Inherited from SPEventPropertiesBase.) |
|
SiteId | Gets the site ID of the event. (Inherited from SPEventPropertiesBase.) |
|
Status | Gets or sets the status of trapping the event. (Inherited from SPEventPropertiesBase.) |
|
TemplateId | Gets the identifier of the template on which the list is based. |
|
UserDisplayName | Gets the display name of the user whose action caused the event. |
|
UserLoginName | Gets the user name of the user whose action caused the event. |
|
Web | Gets a reference to the Web site that contains the list that is affected by the event. |
|
WebId | Gets the GUID of the Web site that contains the list that is affected by the event. |
|
WebUrl | Gets the URL of the Web site in which the event occurred. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Dispose | Closes and releases any resources that are held by the current SPSite and SPWeb objects. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
InvalidateList | Invalidates the current out-of-date list and prepares the list to be refreshed with current list items when the list is called again. |
|
InvalidateWeb | Invalidates the current out-of-date Web object so that the next time it is called the caller will get the current instance of the Web. |
|
MemberwiseClone | (Inherited from Object.) |
|
ToString | (Inherited from Object.) |
Top