ASPxPivotGrid.SaveLayoutToStream(Stream, PivotGridWebOptionsLayout) Method

Saves the pivot grid layout to the specified stream, using the specified settings.

Namespace: DevExpress.Web.ASPxPivotGrid

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

NuGet Package: DevExpress.Web

Declaration

C#

public void SaveLayoutToStream(
    Stream stream,
    PivotGridWebOptionsLayout optionsLayout
)

VB.NET

Public Sub SaveLayoutToStream(
    stream As Stream,
    optionsLayout As PivotGridWebOptionsLayout
)

Parameters

Name	Type	Description
stream	Stream	A Stream descendant to which the pivot grid layout is written.
optionsLayout	PivotGridWebOptionsLayout	A PivotGridWebOptionsLayout object that specifies which options should be saved.

Remarks

Use this SaveLayoutToStream method overload to save specific settings of a pivot grid to a stream. These settings can be restored later, via the ASPxPivotGrid.LoadLayoutFromStream method.

The optionsLayout parameter determines which options should be saved to the stream. For the pivot grid control, you can create a PivotGridWebOptionsLayout object, customize it as required and then pass it as the optionsLayout parameter. Only options enabled in this object will be saved.

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

The SaveLayoutToStream overload without the optionsLayout parameter saves only options specified by the ASPxPivotGrid.OptionsLayout property.

Note

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