WebPartZoneBase.WebParts Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the collection of Web Parts controls contained within a zone.
public:
property System::Web::UI::WebControls::WebParts::WebPartCollection ^ WebParts { System::Web::UI::WebControls::WebParts::WebPartCollection ^ get(); };
[System.ComponentModel.Browsable(false)]
public System.Web.UI.WebControls.WebParts.WebPartCollection WebParts { get; }
[<System.ComponentModel.Browsable(false)>]
member this.WebParts : System.Web.UI.WebControls.WebParts.WebPartCollection
Public ReadOnly Property WebParts As WebPartCollection
Property Value
A WebPartCollection that contains references to all the Web Parts controls in a zone.
- Attributes
Examples
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;
}
Protected Sub Button3_Click(ByVal sender As Object, ByVal e As EventArgs)
Dim builder As New StringBuilder()
builder.AppendLine("<strong>WebPartZone2 WebPart IDs</strong><br />")
Dim part As WebPart
For Each part In WebPartZone1.WebParts
builder.AppendLine("ID: " + part.ID + "; Type: " _
+ part.GetType().ToString() _
+ "<br />")
Next part
Label2.Text = builder.ToString()
Label2.Visible = True
End Sub
Remarks
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.