ASPxDockManager.ClientLayout Event

Allows you to save and restore the previously saved layout of panels and zones managed by the ASPxDockManager.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public event ASPxClientLayoutHandler ClientLayout

VB.NET

Public Event ClientLayout As ASPxClientLayoutHandler

Event Data

The ClientLayout event's data class is ASPxClientLayoutArgs. The following properties provide information specific to this event:

Property	Description
LayoutData	Gets or sets the layout data.
LayoutMode	Indicates whether a control’s layout should be saved or restored.

Remarks

Handle the ClientLayout event to save and restore the layout from a data store.

Save Layout

The event parameter’s LayoutMode property returns Saving. The LayoutData property contains the ASPxDocking’s current layout that should be saved, for example, to a database.

Restore Layout

The LayoutMode property returns Loading. Read the ASPxDocking’s layout data from a data store and assign it to the LayoutData property.

Run Demo: Docking - Layout Management

protected void ASPxDockManager1_ClientLayout(object sender, ASPxClientLayoutArgs e) {
    if (e.LayoutMode == ClientLayoutMode.Saving && this.saveLayout) {
        DataRow row = LayoutDataSource.NewRow();
        row["Date"] = DateTime.Now.ToString();
        row["LayoutString"] = e.LayoutData;
        LayoutDataSource.Rows.Add(row);
    }
    if (e.LayoutMode == ClientLayoutMode.Loading && grid.Selection.Count != 0) {
        e.LayoutData = grid.GetSelectedFieldValues("LayoutString")[0].ToString();
    }
}