ASPxPivotGrid.LoadLayoutFromStream(Stream, PivotGridWebOptionsLayout) Method

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

Namespace: DevExpress.Web.ASPxPivotGrid

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

Declaration

public void LoadLayoutFromStream(
    Stream stream,
    PivotGridWebOptionsLayout optionsLayout
)

Parameters

Name Type Description
stream Stream

A Stream descendant which contains the layout settings. If null (Nothing in Visual Basic), an exception is raised.

optionsLayout PivotGridWebOptionsLayout

A PivotGridWebOptionsLayout object that specifies whose options should be restored.

Remarks

Use the LoadLayoutFromStream method to load the pivot grid layout from the stream to which the layout has been saved via the ASPxPivotGrid.SaveLayoutToStream method.

The optionsLayout parameter determines which options should be restored from the stream. 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 LoadLayoutFromStream method overload without the optionsLayout parameter restores only options specified by the pivot grid’s ASPxPivotGrid.OptionsLayout property.

See Also