PivotGridControl.RestoreCollapsedStateFromStream(Stream) Method

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

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v14.2.dll

Declaration

C#

public void RestoreCollapsedStateFromStream(
    Stream stream
)

VB.NET

Public Sub RestoreCollapsedStateFromStream(
    stream As Stream
)

Parameters

Name	Type	Description
stream	Stream	A Stream descendant from which the collapsed state of field values is read. If null (Nothing in Visual Basic), an exception is raised.

Remarks

Use the RestoreCollapsedStateFromStream method to load the collapsed state of field values which was written to a stream via the PivotGridControl.SaveCollapsedStateToStream 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 RestoreCollapsedStateFromStream method may have no effect, or may restore the collapsed states incorrectly. To ensure that the collapsed states are loaded correctly, prevent end-users from changing the control layout (use the PivotGridControl.AllowDrag and PivotGridControl.AllowHideFields properties), or save and load the field values' collapsed states together with the control layout (use the PivotGridControl.SaveLayoutToStream and PivotGridControl.RestoreLayoutFromStream methods).

NOTE

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