WebPartZoneBase.WebParts Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the collection of Web Parts controls contained within a zone.

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

[BrowsableAttribute(false)]
public WebPartCollection WebParts { get; }

Property Value

Type: System.Web.UI.WebControls.WebParts.WebPartCollection

A WebPartCollection that contains references to all the Web Parts controls in a zone.

The WebParts property can contain references to controls that inherit directly from the WebPart class, as well as other ASP.NET server controls or custom controls within a zone. The Web Parts control set dynamically wraps any control that is not a WebPart control as a GenericWebPart control at run time; this mechanism enables you to use all types of ASP.NET controls as Web Parts controls.

The following code example demonstrates the programmatic use of the WebParts property on a WebPartZone control. For the full code example, including the code-behind source file and the .aspx page that contains the zone in this code, see the WebPartZoneBase class overview.

The following code example accesses the WebParts property programmatically and displays a list of the controls contained in WebPartZone1. After you load the page into a browser, click the button labeled List WebPartZone1 WebParts. The IDs and types of the controls are displayed.

protected void Button3_Click(object sender, EventArgs e)
{
  StringBuilder builder = new StringBuilder();
  builder.AppendLine(@"<strong>WebPartZone1 WebPart IDs</strong><br />");
  foreach (WebPart part in WebPartZone1.WebParts)
  {
    builder.AppendLine("ID: " + part.ID 
                        + "; Type:  " + part.GetType() 
                        + @"<br />");
  }
  Label2.Text = builder.ToString();
  Label2.Visible = true;
}

.NET Framework
Available since 2.0
Return to top
Show: