PivotGridControl.SaveLayoutToXml(String) Method

Saves a Pivot Grid Control’s layout to an XML file.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

Declaration

C#

public void SaveLayoutToXml(
    string xmlFile
)

VB.NET

Public Sub SaveLayoutToXml(
    xmlFile As String
)

Parameters

Name	Type	Description
xmlFile	String	A string value specifying the path to the file where a Pivot Grid Control’s layout should be stored. If an empty string is specified, an exception is raised.

Remarks

Use the SaveLayoutToXml method to save a Pivot Grid Control’s layout to a specific XML file at runtime. The saved settings can then be restored using the PivotGridControl.RestoreLayoutFromXml method.

Note that you should specify unique names for all pivot grid fields to correctly save and restore the layout. You can do this using the PivotGridFieldBase.Name property.

The PivotGridControl.OptionsLayout property controls which settings should be saved to the file.

Note

The expansion states of field values are not saved by the SaveLayoutToXml method.

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

how-to-serialize-pivotgridcontrol-descendants-properties-with-the-controls-layout-e2688/CS/WindowsFormsSample/Form1.cs#L33

pivotGridControl1.Object.String = "test4";
pivotGridControl1.SaveLayoutToXml("test.xml");
pivotGridControl1.Objects.Clear();

VB.NET

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

pivotGridControl1.Object.String = "test4"
pivotGridControl1.SaveLayoutToXml("test.xml")
pivotGridControl1.Objects.Clear()