ASPxGridBase.SaveClientLayout() Method

Saves the grid layout.

Assembly : DevExpress.Web.v25.2.dll

Declaration

C#
VB.NET

csharp

public virtual string SaveClientLayout()

Public Overridable Function SaveClientLayout As String

Returns

Type	Description
String

A String value that contains the ASPxGridView’s layout data.

Remarks

Call the SaveClientLayout method to save the grid layout. To control what information on the layout can be saved, use options provided by the SettingsCookies property.

Use the LoadClientLayout(String) method to load a previously saved layout.

Example: How to Change the Grid Layout in Exported Document

To apply a custom layout to an exported document, call the LoadClientLayout method in the BeforeExport event handler. In this case, the layout settings affect the exported document content only and do not affect the current grid UI.

ASPX

aspx

<dx:ASPxGridView ID="grid" runat="server" DataSourceID="CustomerReportsDataSource" 
    OnBeforeExport="grid_BeforeExport"/>

C#
VB.NET

csharp

protected void Page_Init(object sender, EventArgs e) {
    // Save the default grid layout.
    Session["layout"] = grid.SaveClientLayout();
}
protected void grid_BeforeExport(object sender, DevExpress.Web.ASPxGridBeforeExportEventArgs e) {
    // Load the default layout.
    grid.LoadClientLayout(Session["layout"].ToString());
}

Protected Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs)
    ' Save the default grid layout.
    Session("layout") = grid.SaveClientLayout()
End Sub

Protected Sub grid_BeforeExport(ByVal sender As Object, ByVal e As DevExpress.Web.ASPxGridBeforeExportEventArgs)
    ' Load the default layout.
    grid.LoadClientLayout(Session("layout").ToString())
End Sub