PivotGridControl.SaveLayoutToXml(String) Method

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

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

public void SaveLayoutToXml(
    string xmlFile
)
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.

Examples

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

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

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

Implements

DevExpress.Utils.Serializing.ISupportXtraSerializer.SaveLayoutToXml(String)
See Also