PivotGridControl.RetrieveFieldsAsync(AsyncCompletedHandler) Method

Creates PivotGridField objects for all fields in a data source asynchronously. Allows you to specify custom actions to be performed after this operation is completed.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

public void RetrieveFieldsAsync(
    AsyncCompletedHandler asyncCompleted
)
Public Sub RetrieveFieldsAsync(
    asyncCompleted As AsyncCompletedHandler
)

Parameters

Name Type Description
asyncCompleted AsyncCompletedHandler

A AsyncCompletedHandler delegate referencing a method that should be executed after the operation is completed.

Remarks

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.

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

See Also