ASPxDockZone Class
A zone where panels can be docked.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v24.2.dll
NuGet Package: DevExpress.Web
#Declaration
public class ASPxDockZone :
ASPxWebControl
#Related API Members
The following members return ASPxDockZone objects:
#Remarks
The ASPxDockZone class specifies a zone where panels can be docked. A collection of docked panels can be accessed via the ASPxDockZone.Panels property. A panel is docked to a zone if the panel’s ASPxDockPanel.OwnerZoneUID property is set to the zone’s ASPxDockZone.ZoneUID property value.
Use the ASPxDockZone.ZoneUID property to specify a zone’s unique identifier. This property can be used to obtain a zone at runtime on the server (ASPxDockManager.FindZoneByUID) or client (ASPxClientDockManager.GetZoneByUID) side.
#Create a DockZone Control
#Design Time
The ASPxDockZone control is available on the DX.24.2: Navigation & Layout toolbox tab in the Microsoft Visual Studio IDE.
Drag the control onto a form and customize the control’s settings, or paste the control’s markup in the page’s source code.
<dx:ASPxDockZone runat="server" ID="dockZone" ZoneUID="DockZone_UID"
Height="220px" Width="250px" ClientInstanceName="ClientDockZone">
</dx:ASPxDockZone>
<dx:ASPxDockPanel runat="server" ID="dockPanel" OwnerZoneUID="DockZone_UID"...>
<!--...-->
</dx:ASPxDockPanel>
#Run Time
using DevExpress.Web;
...
protected void Page_Load(object sender, EventArgs e)
{
ASPxDockZone dockZone = new ASPxDockZone();
dockZone.ID = "dockZone";
Page.Form.Controls.Add(dockZone);
dockZone.ClientInstanceName = "ClientDockZone";
dockZone.Height = 220;
dockZone.Width = 250;
dockZone.ZoneUID = "DockZone_UID";
ASPxDockPanel dockPanel = new ASPxDockPanel();
dockPanel.ID = "dockPanel";
Page.Form.Controls.Add(dockPanel);
dockPanel.OwnerZoneUID = "DockZone_UID";
// ...
}
Note
DevExpress controls require that you register special modules, handlers, and options in the Web.
Panels can be arranged within a zone control, one after another, either vertically or horizontally. Use the zone’s ASPxDockZone.Orientation property to control the arrangement of panels within a zone.
An ASPxDockZone control can enlarge its size (Height for a vertically oriented zone and Width for a horizontally oriented zone) to contain a docking panel. To control a zone’s ability to grow, use the ASPxDockZone.AllowGrowing property.
You can provide different appearances for the allowed and forbidden zone states by using a dock zone’s DockZoneStyles.DockingAllowedStyle and DockZoneStyles.DockingForbiddenStyle properties. These appearances are used to highlight zones during panel dragging, and to indicate whether a particular zone is allowed or disallowed from panel docking. You can specify the appearance of a zone section where the panel can be docked, via the DockZoneStyles.PanelPlaceholder property.
Note
The ASPx
- The control’s client-side equivalent is the ASPx
Client object.Dock Zone - On the client side, the client object can be accessed directly by the name specified via the ASPx
Dock property.Zone. Client Instance Name - The available client events can be accessed by using the ASPx
Dock property.Zone. Client Side Events
The control’s client-side API is enabled if the ASPx