WebPartZoneCollection Constructor (ICollection)

 
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.

Initializes an instance of the WebPartZoneCollection class by passing in a collection of WebPartZone objects.

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

public WebPartZoneCollection(
	ICollection webPartZones
)

Parameters

webPartZones
Type: System.Collections.ICollection

An ICollection of WebPartZone objects.

Exception Condition
ArgumentNullException

The collection of zones is null.

ArgumentException

One of the objects in the collection is null or is not of type WebPartZone.

Use the WebPartZoneCollection constructor when you want to create a custom collection of WebPartZone objects to carry out programmatic operations on them. For example, you could access the Zones property and create a subset of WebPartZone objects on a Web Parts page, assigning them to a WebPartZoneCollection object, and then carry out operations on the child controls or various properties of only that subset of zones.

The following code example demonstrates the use of the WebPartZoneCollection constructor. The complete code for the example is found in the Example section of the WebPartZoneCollection class overview.

In the following section of code, notice that it assigns a WebPartZoneCollection object to a variable by retrieving the value of the Zones property. If you wanted, rather than assigning all the zones from the Zones property, you could create an array of WebPartZoneBase objects containing a subset of all the zones on the page, and assign the array to a new WebPartZoneCollection object.

protected void Button5_Click(object sender, EventArgs e)
{
  Label1.Text = String.Empty;

  WebPartZoneCollection zoneCollection = mgr.Zones;
  foreach (WebPartZone zone in zoneCollection)
  {

    if (zone.WebPartVerbRenderMode == WebPartVerbRenderMode.Menu)
      zone.WebPartVerbRenderMode = WebPartVerbRenderMode.TitleBar;
    else
      zone.WebPartVerbRenderMode = WebPartVerbRenderMode.Menu;
  }
}

After the collection is created, you can easily iterate through the collection and perform operations on all the contained zones or their contents. To execute the example code, load the page in a browser, and click the Toggle Verb Render Mode button on each zone. This alternates how the verbs in the title bar of each server control contained in a zone are rendered. The verbs can appear in a drop-down menu, or directly as links in the title bar.

.NET Framework
Available since 2.0
Return to top
Show: