ASPxDockManager Class

A component that is used to manage panels and zones on a page.

Assembly : DevExpress.Web.v25.2.dll

Declaration

C#
VB.NET

csharp

public class ASPxDockManager :
    ASPxWebComponent

Public Class ASPxDockManager
    Inherits ASPxWebComponent

Remarks

An ASPxDockManager component allows you to manage all panels (accessed via the ASPxDockManager.Panels property) and zones (accessed via the ASPxDockManager.Zones property) on a page.

Create a DockManager Control

Design Time

The ASPxDockManager control is available on the DX.25.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.

ASPX

aspx

<dx:ASPxDockManager ID="dockManager" runat="server" ClientInstanceName="ClientDockManager" FreezeLayout="true" />

csharp

using DevExpress.Web;
...
protected void Page_Load(object sender, EventArgs e)
{
    ASPxDockManager dockManager = new ASPxDockManager();
    dockManager.ID = "dockManager";
    Page.Form.Controls.Add(dockManager);

    dockManager.ClientInstanceName = "ClientDockManager";
    dockManager.FreezeLayout = true;
}

Imports DevExpress.Web

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim dockManager As ASPxDockManager = New ASPxDockManager()
    dockManager.ID = "dockManager"
    Page.Form.Controls.Add(dockManager)

    dockManager.ClientInstanceName = "ClientDockManager"
    dockManager.FreezeLayout = True
End Sub

Note

DevExpress controls require that you register special modules, handlers, and options in the Web.config file. You can change this file or switch to the Design tab in the Microsoft Visual Studio IDE to automatically update the Web.config file. Note that this information is automatically registered if you use the DevExpress Template Gallery to create a project.

Use the ASPxDockManager.FreezeLayout property to control whether an end-user can change a panel’s dock state, and rearrange panels within a zone by dragging them. Set this property to true to prohibit an end-user from changing the docking layout.

The ASPxDockManager component provides the ability to reset a layout to its initial state using the ASPxDockManager.ResetLayoutToInitial method.

Note

The ASPxDockManager component provides you with a comprehensive client-side functionality, implemented using JavaScript code:

The component’s client-side equivalent is the ASPxClientDockManager object.
On the client side, the client object can be accessed directly, by the name specified via the ASPxDockManager.ClientInstanceName property.
The available client events can be accessed by using the ASPxDockManager.ClientSideEvents property.

The component’s client-side API is enabled if the ASPxDockManager.ClientInstanceName property is defined, or any client event is handled.