BaseView.RestoreLayoutFromXml(String) Method

Restores a View’s layout from a specific XML file.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public void RestoreLayoutFromXml(
    string xmlFile
)

VB.NET

Public Sub RestoreLayoutFromXml(
    xmlFile As String
)

Parameters

Name	Type	Description
xmlFile	String	A string value specifying the path to the XML file from which View settings are read. If the specified file doesn’t exist, System.IO.FileNotFoundException type exception is raised.

Remarks

Use the RestoreLayoutFromXML method to load the View’s layout previously saved to an XML file with the help of the BaseView.SaveLayoutToXml method.

The ColumnView.OptionsLayout property controls which settings should be restored from the file.

Note

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

Example

This example shows how to save and restore the layout of the GridControl.MainView between application runs. The form’s Load event is handled to restore the layout previously saved to an XML file. The form’s Closing event is handled to save the current layout to the specified file.

Note that the GridControl.ForceInitialize method is called before the layout is restored in the Form.Load event. This method needs to be called before a grid’s settings are changed in the Form.Load event. It finishes the control’s initialization and thus ensures that all the changes that will be made do not conflict with the options that have been customized at design time.

C#

using DevExpress.XtraGrid;
// ...
string fileName = "c:\\XtraGrid_SaveLayoutToXML.xml";

private void Form1_Load(object sender, System.EventArgs e) {
   gridControl1.ForceInitialize();
   // Restore the previously saved layout
   gridControl1.MainView.RestoreLayoutFromXml(fileName);
}

private void Form1_Closing(object sender, System.ComponentModel.CancelEventArgs e) {
   // Save the layout to an XML file
   gridControl1.MainView.SaveLayoutToXml(fileName);
}

VB.NET

Imports DevExpress.XtraGrid
' ...
Dim fileName As String = "c:\XtraGrid_SaveLayoutToXML.xml"

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) _
  Handles MyBase.Load
   GridControl1.ForceInitialize()
   ' Restore the previously saved layout
   GridControl1.MainView.RestoreLayoutFromXml(fileName)
End Sub

Private Sub Form1_Closing(ByVal sender As Object, _
  ByVal e As System.ComponentModel.CancelEventArgs) Handles MyBase.Closing
   ' Save the layout to an XML file
   GridControl1.MainView.SaveLayoutToXml(fileName)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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-hide-the-grid-columns-displayed-in-the-bands-when-grouping-is-applied-e653/CS/Form1.cs#L116

    InitEditors();
    advBandedGridView1.RestoreLayoutFromXml(LayoutFileName);
}

how-to-implement-your-own-serializable-property-for-the-gridcolumn-e1951/CS/Q242361/Form1.cs#L30

{
    myGridView1.RestoreLayoutFromXml(LayoutPath);
}

how-to-include-custom-data-in-the-gridviews-saving-and-restoring-layout-mechanism-e2522/CS/Serialization/Form1.cs#L34

{
    myGridView1.RestoreLayoutFromXml("C:\\1\\1.xml");
    if ( customValue != null )

how-to-store-only-specific-views-settings-to-a-file-e600/CS/WindowsApplication1/Form1.cs#L39

{
    gridView1.RestoreLayoutFromXml("test.xml");
}

VB.NET

how-to-hide-the-grid-columns-displayed-in-the-bands-when-grouping-is-applied-e653/VB/Form1.vb#L108

    InitEditors()
    advBandedGridView1.RestoreLayoutFromXml(LayoutFileName)
End If

how-to-implement-your-own-serializable-property-for-the-gridcolumn-e1951/VB/Q242361/Form1.vb#L31

Private Sub simpleButton2_Click(ByVal sender As Object, ByVal e As EventArgs) Handles simpleButton2.Click
    myGridView1.RestoreLayoutFromXml(LayoutPath)
End Sub

how-to-include-custom-data-in-the-gridviews-saving-and-restoring-layout-mechanism-e2522/VB/Serialization/Form1.vb#L31

Private Sub simpleButton2_Click(ByVal sender As Object, ByVal e As EventArgs) Handles simpleButton2.Click
    myGridView1.RestoreLayoutFromXml("C:\1\1.xml")
    If customValue IsNot Nothing Then

how-to-store-only-specific-views-settings-to-a-file-e600/VB/WindowsApplication1/Form1.vb#L36

Private Sub simpleButton2_Click(ByVal sender As Object, ByVal e As EventArgs) Handles simpleButton2.Click
    gridView1.RestoreLayoutFromXml("test.xml")
End Sub