PivotGridControl.RestoreLayoutFromXml(String) Method

Restores a Pivot Grid Control’s layout from the specified XML file.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v18.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 Pivot Grid Control’s settings are read. If the specified file doesn’t exist, an exception is raised.

Remarks

Use the RestoreLayoutFromXml method to load the Pivot Grid Control’s layout which was written to a file in the XML format using the PivotGridControl.SaveLayoutToXml method.

The PivotGridControl.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 PivotGridControl.ForceInitialize method prior to the layout restoration. See this method to learn more.

Example

The code below demonstrates how the Pivot Grid Control’s layout can be saved to and then restored from an XML file.

C#

string fileName = "c:\\XtraPivotGrid_Layout.xml";
// Saves layout to an XML file.
pivotGridControl1.SaveLayoutToXml(fileName);

// ...
// Restores the previously saved layout.
pivotGridControl1.RestoreLayoutFromXml(fileName);

VB.NET

Dim fileName As String = "c:\XtraPivotGrid_Layout.xml"
' Saves layout to an XML file.
PivotGridControl1.SaveLayoutToXml(fileName)

' ...
' Restores the previously saved layout.
PivotGridControl1.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-pivotgridcontrol-descendants-properties-with-the-controls-layout-e2688/CS/WindowsFormsSample/Form1.cs#L36

    pivotGridControl1.Object.String = null;
    pivotGridControl1.RestoreLayoutFromXml("test.xml");
}

VB.NET

how-to-serialize-pivotgridcontrol-descendants-properties-with-the-controls-layout-e2688/VB/WindowsFormsSample/Form1.vb#L38

    pivotGridControl1.Object.String = Nothing
    pivotGridControl1.RestoreLayoutFromXml("test.xml")
End Sub