Edit

WebPartManager.WebPartClosing Event

  • Reference

Definition

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

Occurs during the process of removing a WebPart control (or server or user control) from a page.

public:
 event System::Web::UI::WebControls::WebParts::WebPartCancelEventHandler ^ WebPartClosing;
public event System.Web.UI.WebControls.WebParts.WebPartCancelEventHandler WebPartClosing;
member this.WebPartClosing : System.Web.UI.WebControls.WebParts.WebPartCancelEventHandler 
Public Custom Event WebPartClosing As WebPartCancelEventHandler

Event Type

WebPartCancelEventHandler

Remarks

The WebPartClosing event is raised by the OnWebPartClosing method when the WebPartManager control is in the process of closing a control. If the removal of the control is successful, this event is followed by the WebPartClosed event.

Page developers can provide a custom handler for the event by adding the OnWebPartClosed attribute to the <asp:webpartmanager> element in a page, and assigning a custom method name to the attribute.

Normally, when the WebPartClosing event is raised as a direct result of a user closing a WebPart control, the event can be cancelled. However, there is a scenario in which the event cannot be cancelled. If a WebPartZone control is deleted, the WebPart controls it contains must all be closed, otherwise they would be orphaned. In this case the WebPartManager control closes the WebPart controls, not the user. And when the WebPartManager control is in the process of calling the CloseWebPart method to close each control, and the WebPartClosing event is raised, the event cannot be cancelled (by design) because the WebPartManager needs to complete the task of cleaning up all the zone's controls.

Applies to

See also