PivotGridControl.RestoreCollapsedStateFromStreamAsync(Stream) Method
Restores the collapsed state of field values from the specified stream asynchronously.
Namespace: DevExpress.Xpf.PivotGrid
Assembly: DevExpress.Xpf.PivotGrid.v23.2.dll
NuGet Package: DevExpress.Wpf.PivotGrid
Declaration
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. |
Returns
| Type | Description |
|---|---|
| Task<Boolean> | An asynchronous operation that returns true in case of success. |
Remarks
The RestoreCollapsedStateFromStreamAsync method is asynchronous. It starts executing the related operation in a background thread, and immediately returns control. The primary UI thread is not blocked, allowing the application to continue responding to end-user actions. For more information about the asynchronous mode, see Asynchronous Mode.
If you need to perform specific actions after this operation is completed, use another overload of the RestoreCollapsedStateFromStreamAsync method that takes the asyncCompleted parameter, and pass a delegate that performs the required actions as this parameter.
Use the RestoreCollapsedStateFromStreamAsync method to load the collapsed state of field values 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 RestoreCollapsedStateFromStreamAsync 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 (the PivotGridControl.AllowDrag and PivotGridControl.AllowHideFields properties), or save and load the field values’ collapsed states together with the control layout (the PivotGridControl.SaveLayoutToStream and PivotGridControl.RestoreLayoutFromStream methods).
Note
The RestoreCollapsedStateFromStreamAsync method has no effect if used when data is not loaded (i.e. the PivotGridControl.DataSource property is not initialized).