TreeList.RestoreLayoutFromXml(String) Method

Loads a control’s layout from the specified XML file.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.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 specifying the XML file from which control settings are read.

Remarks

Use the RestoreLayoutFromXML method to load the TreeList control’s layout from an XML file. Control settings must have previously been written to this file via the TreeList.SaveLayoutToXml method call.

The Tree List options that are restored are identified by the TreeList.OptionsLayout object.

Note

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

Example

The following sample code saves the layout of the Tree List control to an XML file and then restores it. The TreeList.SaveLayoutToXml and TreeList.RestoreLayoutFromXml methods are used for this purpose.

C#

string fileName = "c:\\TreeListLayout.xml";
treeList1.SaveLayoutToXml(fileName);
treeList2.DataSource = treeList1.DataSource;
treeList2.RestoreLayoutFromXml(fileName);

VB.NET

Dim FileName As String = "c:\TreeListLayout.xml"
TreeList1.SaveLayoutToXml(FileName)
TreeList2.DataSource = TreeList1.DataSource
TreeList2.RestoreLayoutFromXml(FileName)

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-serialize-treelists-formatconditions-e1984/CS/E1984/Form1.cs#L35

    MessageBox.Show("Restore");
    treeList1.RestoreLayoutFromXml(MyTreeListSerializeHelper.DefaultFileName);
}

VB.NET

how-to-serialize-treelists-formatconditions-e1984/VB/E1984/Form1.vb#L35

    MessageBox.Show("Restore")
    treeList1.RestoreLayoutFromXml(DefaultFileName)
End Sub