PivotGridControl.RetrieveFieldsAsync() Method

Creates PivotGridField objects for all fields in a data source asynchronously.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v21.2.dll


public Task<bool> RetrieveFieldsAsync()




The RetrieveFieldsAsync method clears the PivotGridControl.Fields collection and adds new PivotGridField objects for all fields in a data source. The PivotGridFieldBase.FieldName property of each field is set to the name of the corresponding data source field. The created fields are made visible and displayed within the Filter Header Area.

To learn more about fields, see Pivot Grid Fields.

The RetrieveFieldsAsync 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 RetrieveFieldsAsync method that takes the asyncCompleted parameter, and pass a delegate that performs the required actions as this parameter.

To create fields synchronously, use the PivotGridControl.RetrieveFields method.

See Also