BaseView.RestoreLayoutFromStream(Stream, Boolean) Method

SECURITY NOTE

Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization.

Restores the layout from a stream that contains data in a specific format.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public void RestoreLayoutFromStream(
    Stream stream,
    bool binaryStream
)

VB.NET

Public Sub RestoreLayoutFromStream(
    stream As Stream,
    binaryStream As Boolean
)

Parameters

Name	Type	Description
stream	Stream	The stream from which the layout should be restored.
binaryStream	Boolean	true if the stream contains data in binary format; false if the stream contains data in XML format.

Remarks

Use the following methods to save the layout in the corresponding format/storage and subsequently restore it:

• XML/file system
  • SaveLayoutToXml(String) — saves the layout in a specific file in XML format. The path parameter specifies the file to which the view writes the XML data. If the file does not exist, the view creates a new file.
  • RestoreLayoutFromXml(String) — restores the layout from the specified XML file.
• XML/stream
  • SaveLayoutToXml(Stream) — saves the layout in a specific stream in XML format. The stream parameter specifies the stream to which the view writes the XML data.
  • SaveLayoutToStream(Stream, Boolean) — set the binaryStream parameter to false to save the layout in XML format.
  • RestoreLayoutFromXml(Stream) — restores the layout from the specified stream.
• binary/stream
  • SaveLayoutToStream(Stream) — saves the layout in a specific stream in binary format. The stream parameter specifies the stream to which the view writes the binary data.
  • SaveLayoutToStream(Stream, Boolean) — set the binaryStream parameter to true to save the layout in binary format.
  • RestoreLayoutFromStream(Stream) — restores the layout from the specified stream.
• registry
  • SaveLayoutToRegistry(String) — saves the layout in the system registry.
  • RestoreLayoutFromRegistry(String) — restores the layout from the system registry.

You can handle the BaseView.RestoreLayoutError event to fix exceptions that occur during the restore layout operation.

Important

The Layout Control saves and restores the View’s properties and properties of documents. It does not recreate documents with their content. You should recreate documents and then restore the layout.

The ControlName property should be set to a unique value for documents populated with the content on the fly (see Deferred Load) to restore documents correctly.

Tip

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