DockManager.SaveLayoutToXml(String) Method

Saves the layout of dock panels to an XML file.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v19.1.dll

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 which specifies the path to the file where the layout of dock panels should be stored. If an empty string is specified, an exception is raised.

Remarks

After the layout of dock panels has been saved using the SaveLayoutToXml method it can then be restored using the DockManager.RestoreLayoutFromXml method.

For more information, see Saving and Restoring the Layout of Dock Panels

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 following code can be used to read and write the layout of dock panels from and to an XML file.

C#

string xmlFile = "c:\\XtraBars\\DockStates\\MainState.xml";
dockManager1.SaveLayoutToXml(xmlFile);

// ...

dockManager1.RestoreLayoutFromXml(xmlFile);

VB.NET

Dim xmlFile As String = "c:\XtraBars\DockStates\MainState.xml"
DockManager1.SaveLayoutToXml(xmlFile)

    '...

DockManager1.RestoreLayoutFromXml(xmlFile)

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#

a-dynamically-created-dockpanel-loses-its-child-controls-after-its-layout-is-restored-e842/CS/Form1.cs#L31

private void SaveLayoutToXml(object sender, EventArgs e) {
    dockManager1.SaveLayoutToXml(DockingLayoutFile);
}

VB.NET

a-dynamically-created-dockpanel-loses-its-child-controls-after-its-layout-is-restored-e842/VB/Form1.vb#L46

Private Sub SaveSettings()
    dockManager1.SaveLayoutToXml(DockingLayoutFile)
End Sub