LayoutControl.SaveLayoutToXml(String) Method

Saves the layout to an XML file.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public virtual void SaveLayoutToXml(
    string xmlFile
)

VB.NET

Public Overridable Sub SaveLayoutToXml(
    xmlFile As String
)

Parameters

Name	Type	Description
xmlFile	String	A String value that specifies the path to the file where the layout should be stored. If an empty string is specified, an exception is raised.

Remarks

Use the SaveLayoutToXml method to save the current layout to a file in XML format at runtime. The saved settings can then be restored using the LayoutControl.RestoreLayoutFromXml method.

See Save and Restore Layout to learn more.

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 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 SaveLayoutToXml(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#L38

string filePathForControls = filePath.Replace(".xml", "Controls.xml");
layoutControl.SaveLayoutToXml(filePath);
serializer.SerializeObject(objects, filePathForControls, appName);

VB.NET

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

Dim filePathForControls As String = filePath.Replace(".xml", "Controls.xml")
layoutControl.SaveLayoutToXml(filePath)
serializer.SerializeObject(objects, filePathForControls, appName)