Export (0) Print
Expand All

WebPartZoneBase.CloseWebPart Method

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.

ExceptionCondition
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.

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft