PivotGridControl.RestoreCollapsedStateFromFile(String) Method

Restores the collapsed state of field values from the specified file.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v24.1.dll

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public void RestoreCollapsedStateFromFile(
    string path
)

VB.NET

Public Sub RestoreCollapsedStateFromFile(
    path As String
)

Parameters

Name	Type	Description
path	String	A String value which specifies the path to the file from which the collapsed state of field values is read. If the specified file doesn’t exist, an exception is raised.

Remarks

Use the RestoreCollapsedStateFromFile method to load the collapsed state of field values written to a stream using the PivotGridControl.SaveCollapsedStateToFile method.

The collapsed states of field values can only be restored in the same layout they were saved in. If the control layout was changed after saving the collapsed states (for instance, some fields have been reordered or hidden), the RestoreCollapsedStateFromFile method may have no effect, or may restore the collapsed states incorrectly. To ensure that the collapsed states are loaded correctly, do one of the following

• prevent end-users from changing the control layout (the PivotGridControl.AllowDrag and PivotGridControl.AllowHideFields properties);
• save the collapsed state together with the current control layout (the PivotGridControl.SaveLayoutToXml method); then, you can use the RestoreCollapsedStateFromFile method along with PivotGridControl.RestoreLayoutFromXml to restore the collapsed state with saved layout.

Note

The RestoreCollapsedStateFromFile method has no effect if used when data is not loaded (i.e., the PivotGridControl.DataSource property is not initialized).

Note

The collapsed states for server mode and regular data sources are stored in different formats and not compatible with each other. Some issues can appear on restoring the collapsed state from different data source modes.