SPWebEventReceiver.WebDeleting Method
Synchronous Before event that occurs before an existing Web site is completely deleted.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online
Syntax
'Declaration
Public Overridable Sub WebDeleting ( _
properties As SPWebEventProperties _
)
'Usage
Dim instance As SPWebEventReceiver
Dim properties As SPWebEventProperties
instance.WebDeleting(properties)
public virtual void WebDeleting(
SPWebEventProperties properties
)
Parameters
properties
Type: Microsoft.SharePoint.SPWebEventPropertiesAn SPWebEventProperties object that represents properties of the event handler.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | properties is null . |
Remarks
Web site deletion events occur in the following cases:
The Web site is deleted through the user interface.
The folder that contains a Web site is deleted in an application that is compatible with Microsoft SharePoint Foundation (such as Microsoft Office SharePoint Designer 2007) through remote procedure call protocol (RPC).
The folder that contains a Web site is deleted through Distributed Authoring and Versioning (DAV).
Web site deletion events only occur for the first Web site in a chain of sites. For example, if a Web site at http://TopSite/Site, which has the subwebs http://TopSite/Site/Subsite1 and http://TopSite/Site/Subsite2, is deleted in Office SharePoint Designer 2007, only one deletion event occurs, namely, for the http://TopSite/Site root Web site.
This event supports event cancellation and error messages.
Warning
You should not use the property setting Status=CancelNoError to cancel an event, since doing so redirects the user to the noninformative "Delete Web" page.