PivotGridControl.SaveLayoutToStream(Stream) Method

Saves a Pivot Grid Control’s layout to the specified stream.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.1.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public void SaveLayoutToStream(
    Stream stream
)

VB.NET

Public Sub SaveLayoutToStream(
    stream As Stream
)

Parameters

Name	Type	Description
stream	Stream	A Stream descendant to which a Pivot Grid Control’s layout is written.

Remarks

Use the SaveLayoutToStream method to write a Pivot Grid Control’s layout to a stream. The layout can then be read using the PivotGridControl.RestoreLayoutFromStream method.

The PivotGridControl.OptionsLayout property controls which settings should be saved to the stream.

Note

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

Tip

You can utilize the Persistence Behavior or Workspace Manager component to save and restore layouts for all supported DevExpress controls at once.

Example

The following sample code saves a Pivot Grid Control’s layout to a memory stream and then restores it.

C#

System.IO.Stream stream;
stream = new System.IO.MemoryStream();
pivotGridControl1.SaveLayoutToStream(stream);
stream.Seek(0, System.IO.SeekOrigin.Begin);

// ...
pivotGridControl1.RestoreLayoutFromStream(stream);
stream.Seek(0, System.IO.SeekOrigin.Begin);

VB.NET

Dim stream As System.IO.Stream
stream = New System.IO.MemoryStream()
PivotGridControl1.SaveLayoutToStream(stream)
stream.Seek(0, System.IO.SeekOrigin.Begin)

' ...
PivotGridControl1.RestoreLayoutFromStream(stream)
stream.Seek(0, System.IO.SeekOrigin.Begin)

Related GitHub Examples

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

pivot-grid-for-winforms-layout-upgrade/CS/WinPivotUpgradeLayout/Form1.cs#L44

private void simpleButton1_Click(object sender, EventArgs e){
    pivotGridControlOld.SaveLayoutToStream(layoutStream);
}

VB.NET

pivot-grid-for-winforms-layout-upgrade/VB/WinPivotUpgradeLayout/Form1.vb#L46

Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As EventArgs)
    pivotGridControlOld.SaveLayoutToStream(layoutStream)
End Sub