LayoutControl.RestoreLayoutFromXml(String) 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 the specified XML file.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v24.2.dll

Declaration

C#

public virtual void RestoreLayoutFromXml(
    string xmlFile
)

VB.NET

Public Overridable Sub RestoreLayoutFromXml(
    xmlFile As String
)

Parameters

Name	Type	Description
xmlFile	String	A String value which specifies the path to the XML file that contains the layout to be loaded. If the specified file doesn’t exist, an exception is raised.

Remarks

The RestoreLayoutFromXml method loads a layout that has been saved to a file in XML format using the LayoutControl.SaveLayoutToXml method.

See Save and Restore Layout to learn more.

Example

The code below demonstrates how the layout can be saved to and then restored from an XML file.

C#

string f = "c:\\Layout.xml";
// Save the layout to an XML file.
layoutControl1.SaveLayoutToXml(f);
// ...
// Restore a previously saved layout.
layoutControl1.RestoreLayoutFromXml(f);

VB.NET

Dim f As String = "c:\Layout.xml"
' Save the layout to an XML file.
LayoutControl1.SaveLayoutToXml(f)
' ...
' Restore a previously saved layout.
LayoutControl1.RestoreLayoutFromXml(f)

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RestoreLayoutFromXml(String) 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-save-a-layout-of-layoutcontrol-together-with-its-child-controls-t131174/CS/WindowsApplication3/Serializer.cs#L66

    }
    layoutControl.RestoreLayoutFromXml(filePath);
}

VB.NET

how-to-save-a-layout-of-layoutcontrol-together-with-its-child-controls-t131174/VB/WindowsApplication3/Serializer.vb#L61

    Next info
    layoutControl.RestoreLayoutFromXml(filePath)
Catch exc As Exception