BaseView.RestoreLayoutFromStream(Stream) Method

Restores a View’s layout from the specified stream.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.2.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 View settings are read.

Remarks

Use the RestoreLayoutFromStream method to load the View’s layout from the stream to which the layout was saved via the BaseView.SaveLayoutToStream method. If the specified stream is empty or null (Nothing in Visual Basic), an exception is raised.

The ColumnView.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 GridControl.ForceInitialize method prior to the layout restoration. See this method to learn more.

Example

The following sample code saves the layout of the active View to a memory stream and then restores it. The BaseView.SaveLayoutToStream and BaseView.RestoreLayoutFromStream methods are used for this purpose.

C#

System.IO.Stream str;
//...
// Create and save the view's layout to a new memory stream.
str = new System.IO.MemoryStream();
gridControl1.FocusedView.SaveLayoutToStream(str);
str.Seek(0, System.IO.SeekOrigin.Begin);

// ...
// Load the view's layout from a previously saved memory stream.
gridControl1.FocusedView.RestoreLayoutFromStream(str);
str.Seek(0, System.IO.SeekOrigin.Begin);

VB.NET

Dim str As System.IO.Stream
'...
' Create and save the view's layout to a new memory stream.
str = New System.IO.MemoryStream()
GridControl1.FocusedView.SaveLayoutToStream(str)
str.Seek(0, System.IO.SeekOrigin.Begin)

' ...
' Load the view's layout from a previously saved memory stream.
GridControl1.FocusedView.RestoreLayoutFromStream(str)
str.Seek(0, System.IO.SeekOrigin.Begin)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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-restore-the-auto-filter-row-from-an-active-filter-after-restoring-the-layout-e1759/CS/WindowsApplication1/E1759.cs#L38

GridView gridView = (GridView)grid.DefaultView;
gridView.RestoreLayoutFromStream(typeof(E1759).Assembly.GetManifestResourceStream("WindowsApplication1.layout.xml"));
//gridView.GuessAutoFilterRowValuesFromFilter();

how-to-specify-visibility-of-rows-in-gridview-during-printing-export-e3174/CS/ExportToXlsx/ExportHelper.cs#L138

    LayoutStream.Seek(0, SeekOrigin.Begin);
    view.RestoreLayoutFromStream(LayoutStream);
}

winforms-dashboard-data-inspector-customization/CS/Form1.cs#L48

if(layouts.TryGetValue(itemName, out stream)) {
    gridView.RestoreLayoutFromStream(stream);
    stream.Seek(0, System.IO.SeekOrigin.Begin);

VB.NET

how-to-restore-the-auto-filter-row-from-an-active-filter-after-restoring-the-layout-e1759/VB/WindowsApplication1/E1759.vb#L38

Dim view As GridView = CType(grid.DefaultView, GridView)
view.RestoreLayoutFromStream(GetType(E1759).Assembly.GetManifestResourceStream("layout.xml"))
'view.GuessAutoFilterRowValuesFromFilter()

how-to-specify-visibility-of-rows-in-gridview-during-printing-export-e3174/VB/ExportToXlsx/ExportHelper.vb#L134

    LayoutStream.Seek(0, SeekOrigin.Begin)
    view.RestoreLayoutFromStream(LayoutStream)
End If

winforms-dashboard-data-inspector-customization/VB/Form1.vb#L49

If layouts.TryGetValue(itemName, stream) Then
    gridView.RestoreLayoutFromStream(stream)
    stream.Seek(0, System.IO.SeekOrigin.Begin)