ASPxPivotGrid.LoadLayoutFromString(String, PivotGridWebOptionsLayout) Method

Restores the pivot grid layout from the specified string, using the specified settings.

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.v20.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

public void LoadLayoutFromString(
    string layoutState,
    PivotGridWebOptionsLayout optionsLayout
)

VB.NET

Public Sub LoadLayoutFromString(
    layoutState As String,
    optionsLayout As PivotGridWebOptionsLayout
)

Parameters

Name	Type	Description
layoutState	String	A String from which pivot grid settings are read.
optionsLayout	PivotGridWebOptionsLayout	A PivotGridWebOptionsLayout object that specifies which options should be restored.

Remarks

Use the LoadLayoutFromString method to load the pivot grid layout from the string to which the layout has been saved via the ASPxPivotGrid.SaveLayoutToString method.

The optionsLayout parameter determines which options should be restored from the string. For a pivot grid control, a PivotGridWebOptionsLayout object can be created, customized as required, and then passed as the optionsLayout parameter. Only options enabled in this object will be restored.

To restore all options, pass null (Nothing in Visual Basic) or the static PivotGridWebOptionsLayout.FullLayout property as the optionsLayout parameter.

The LoadLayoutFromString method overload without the optionsLayout parameter restores only options specified by the pivot grid’s ASPxPivotGrid.OptionsLayout property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LoadLayoutFromString(String, PivotGridWebOptionsLayout) 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#

save-load-field-values-collapsed-states-together-with-pivot-grids-layout-e20015/CS/ASPxPivotGrid_SaveLoadCollapsedState/Default.aspx.cs#L26

}
ASPxPivotGrid1.LoadLayoutFromString(layout, PivotGridWebOptionsLayout.DefaultLayout  );
collapseStateStream.Seek(0, SeekOrigin.Begin);

VB.NET

save-load-field-values-collapsed-states-together-with-pivot-grids-layout-e20015/VB/ASPxPivotGrid_SaveLoadCollapsedState/Default.aspx.vb#L27

End If
ASPxPivotGrid1.LoadLayoutFromString(layout, PivotGridWebOptionsLayout.DefaultLayout)
collapseStateStream.Seek(0, SeekOrigin.Begin)