PivotGridControl.RestoreLayoutFromStream(Stream) Method

Restores a Pivot Grid Control’s layout from the specified stream.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

Declaration

C#

public void RestoreLayoutFromStream(
    Stream stream
)

VB.NET

Public Sub RestoreLayoutFromStream(
    stream As Stream
)

Parameters

Name	Type	Description
stream	Stream	A Stream descendant from which the Pivot Grid Control’s settings are read. If null (Nothing in Visual Basic), an exception is raised.

Remarks

Use the RestoreLayoutFromStream method to load the Pivot Grid Control’s layout from the stream to which the layout was saved via the PivotGridControl.SaveLayoutToStream method.

The PivotGridControl.OptionsLayout property controls which settings should be restored from the stream.

Note

When restoring a layout during a form load (for instance, in your Form.Load event handler), you may need to call the PivotGridControl.ForceInitialize method prior to the layout restoration. See this method to learn more.

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 RestoreLayoutFromStream(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#

how-to-prevent-pivotgridfieldoptions-property-from-being-serialized-e2230/CS/DxSample/Form1.cs#L46

using(FileStream stream = new FileStream(LayoutFile, FileMode.Open, FileAccess.Read)) {
    pivotGrid1.RestoreLayoutFromStream(stream);
}

VB.NET

how-to-prevent-pivotgridfieldoptions-property-from-being-serialized-e2230/VB/DxSample/Form1.vb#L50

Using stream As New FileStream(LayoutFile, FileMode.Open, FileAccess.Read)
    pivotGrid1.RestoreLayoutFromStream(stream)
End Using