WebPartManager.OnWebPartDeleting(WebPartCancelEventArgs) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Raises the WebPartDeleting event, which indicates that a dynamic WebPart control (or server or user control that is contained in a WebPartZoneBase zone) is in the process of being deleted.

protected:
 virtual void OnWebPartDeleting(System::Web::UI::WebControls::WebParts::WebPartCancelEventArgs ^ e);

protected virtual void OnWebPartDeleting (System.Web.UI.WebControls.WebParts.WebPartCancelEventArgs e);

abstract member OnWebPartDeleting : System.Web.UI.WebControls.WebParts.WebPartCancelEventArgs -> unit
override this.OnWebPartDeleting : System.Web.UI.WebControls.WebParts.WebPartCancelEventArgs -> unit

Protected Overridable Sub OnWebPartDeleting (e As WebPartCancelEventArgs)

Parameters

e: WebPartCancelEventArgs

A WebPartCancelEventArgs that contains the event data.

Remarks

Only dynamic WebPart controls can be deleted, and when a control is deleted, the control instance is permanently removed from a page and cannot be restored. Dynamic WebPart controls are those that are added programmatically, or from a Web Parts catalog, as opposed to static controls that are declared in the markup of a Web page.

The OnWebPartDeleting method raises the WebPartDeleting event to indicate that a control is being permanently deleted from its zone. The method also provides the opportunity to cancel the deleting process. If the control is successfully deleted from the page, the WebPartDeleted event follows.

Page developers can provide a custom handler for the associated event by adding the OnWebPartDeleting attribute to the <asp:webpartmanager> element on a Web page, and then assigning a custom method name to the attribute.

Notes to Inheritors

Developers who create derived WebPartManager classes can override the OnWebPartDeleting(WebPartCancelEventArgs) method to customize the event handling.

Applies to

Share via