DockManager.RestoreLayoutFromXml(String) Method

Restores the layout of dock panels from the specified XML file.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v19.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 from which the layout is read. If the specified file doesn’t exist, an exception is raised.

Remarks

Note

When restoring a layout during a form load (for instance, in your Form.Load event handler), you may need to call the DockManager.ForceInitialize method prior to the layout restoration. See this method to learn more.

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

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 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#

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

    if(System.IO.File.Exists(DockingLayoutFile))
        dockManager1.RestoreLayoutFromXml(DockingLayoutFile);
}

VB.NET

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

If System.IO.File.Exists(DockingLayoutFile) Then
    dockManager1.RestoreLayoutFromXml(DockingLayoutFile)
End If