WebPartManager::AddWebPart Method
Provides the standard programmatic method for adding WebPart controls to a Web page.
Assembly: System.Web (in System.Web.dll)
public: WebPart^ AddWebPart( WebPart^ webPart, WebPartZoneBase^ zone, int zoneIndex )
Parameters
- webPart
- Type: System.Web.UI.WebControls.WebParts::WebPart
The WebPart (or server or user control) to be added to a Web page or opened on a page.
- zone
- Type: System.Web.UI.WebControls.WebParts::WebPartZoneBase
The WebPartZoneBase that webPart is being added to.
- zoneIndex
- Type: System::Int32
An integer that represents the ordinal position that webPart occupies in zone, relative to other controls in zone.
Return Value
Type: System.Web.UI.WebControls.WebParts::WebPartA WebPart control that was added to the page.
| Exception | Condition |
|---|---|
| ArgumentNullException | webPart is nullptr. - or - zone is nullptr. |
| ArgumentException | zone is not registered in the WebPartManager control's collection of zones. - or - webPart is already in zone. |
| ArgumentOutOfRangeException | The value of zoneIndex is less than zero. |
The AddWebPart method is used both to add new dynamic WebPart controls to a page, and to reopen static or dynamic controls that have previously been closed on a page. When the method is called to add a new control, it actually creates a copy of the control referenced in the webPart parameter. A new ID is generated for the copy of the control, so developers should reference the WebPart control returned from the method to get the new ID value. When the method is called to reopen a previously closed control, it returns a direct reference to the control referenced by the webPart parameter.
Important Note: |
|---|
You should always use the AddWebPart method, rather than the Add method of the collection of controls referenced by the WebPartManager::Controls property, to add WebPart controls programmatically to the page, because using the Add method throws an exception. To add a control that is not a WebPart control (in other words, a server control that will be wrapped with a GenericWebPart control at run time), you should first call the CreateWebPart method to create the control, and then call the AddWebPart method to add the control. For a demonstration of this approach, see the Example section. |
The following code example demonstrates use of the AddWebPart method to add a server control programmatically to a page. The page markup contains an empty <asp:webpartzone> element, and an <asp:webpartmanager> element. The first time the Add Calendar button is clicked, the code in the event handler creates a Calendar control, and adds it to a zone as a GenericWebPart object, calling the AddWebPart method.
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.
Important Note: