WebPartZoneBase.CloseWebPart Method (WebPart)

 

Closes a selected WebPart control in a zone.

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

protected virtual void CloseWebPart(
	WebPart webPart
)

Parameters

webPart
Type: System.Web.UI.WebControls.WebParts.WebPart

The WebPart control to be closed.

Exception Condition
ArgumentNullException

webPart is null.

The typical way for an end user to close a WebPart control is by clicking the close verb in the control's title bar. The CloseWebPart method calls the CloseWebPart method on the WebPartManager class, which carries out the action of closing the control. The method should only be used by derived WebPartZoneBase zones such as WebPartZone.

A closed WebPart control is not rendered on a page. Instead, it is added to the page catalog, which maintains a list of all closed controls on a page. If a Web Parts page on which a user closes a control also has an <asp:PageCatalogPart> element declared with a CatalogZone, then the user can switch the page into catalog display mode, and add the closed control back to the page.

System_CAPS_noteNote

For a user to be able to close a WebPart control, the AllowClose property on the control and the AllowLayoutChange property on the zone must both be set to true.

.NET Framework
Available since 2.0
Return to top
Show: