WebPartZoneCollection.CopyTo Method (WebPartZoneBase[], Int32)

 
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.

Copies the collection to an array of WebPartZoneBase objects.

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

public void CopyTo(
	WebPartZoneBase[] array,
	int index
)

Parameters

array
Type: System.Web.UI.WebControls.WebParts.WebPartZoneBase[]

A WebPartZoneBase array to contain the copied collection.

index
Type: System.Int32

The starting point in the array at which to place the collection contents.

The CopyTo method is useful when you want to create a custom array that can contain the zones in the WebPartZoneCollection collection, a subset of those zones, or a superset of those zones.

The following code example demonstrates the use of the CopyTo method. The complete code for the example, including a user control, a page containing the zones, and a partial class file that contains the code, is found in the Example section of the WebPartZoneCollection class overview.

The following section of the code demonstrates usage of the CopyTo method. To execute the code, load the page in a browser, and click the Zone Names from Array button. The collection of zones is loaded into an array, and all zone IDs are copied into a label.

protected void Button3_Click(object sender, EventArgs e)
{
  Label1.Text = String.Empty;
  WebPartZoneBase[] zoneArray = new WebPartZoneBase[mgr.Zones.Count];
  mgr.Zones.CopyTo(zoneArray, 0);
  Label1.Text = zoneArray[2].ID;
  Label1.Text += ", " + zoneArray[1].ID;
  Label1.Text += ", " + zoneArray[0].ID;
}

.NET Framework
Available since 2.0
Return to top
Show: