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.v21.1.dll

Declaration

public void LoadLayoutFromString(
    string layoutState,
    PivotGridWebOptionsLayout optionsLayout
)

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.

See Also