ASPxPivotGrid.SaveLayoutToString() Method

Saves the pivot grid layout to the specified string.

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public string SaveLayoutToString()

VB.NET

Public Function SaveLayoutToString As String

Returns

Type	Description
String	A String that specifies the string to which the pivot grid layout is written.

Remarks

Use the SaveLayoutToString method to write the pivot grid layout to a string. The layout can then be read using the ASPxPivotGrid.LoadLayoutFromString method.

The ASPxPivotGrid.OptionsLayout property controls whose settings should be saved to the string.

Note

The expansion states of field values are not saved by the SaveLayoutToString method.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SaveLayoutToString() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

aspxpivotgrid-layout-upgrade-event/CS/ASPxPivotGridLayoutUpgradeEvent/Default.aspx.cs#L29

protected void SaveLayout_Click(object sender, EventArgs e) {
    Session["Layout"] = ASPxPivotGridOld.SaveLayoutToString();
}

VB.NET

aspxpivotgrid-layout-upgrade-event/VB/ASPxPivotGridLayoutUpgradeEvent/Default.aspx.vb#L30

Protected Sub SaveLayout_Click(ByVal sender As Object, ByVal e As EventArgs)
    Session("Layout") = ASPxPivotGridOld.SaveLayoutToString()
End Sub