PivotGridField.SetFilterValuesAsync(Object[], FieldFilterType, Boolean, AsyncCompletedHandler) Method

Adds the specified filter values to the collection asynchronously.

Namespace: DevExpress.Xpf.PivotGrid

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

Declaration

public bool SetFilterValuesAsync(
    object[] values,
    FieldFilterType filterType,
    bool showBlanks,
    AsyncCompletedHandler handler
)
Public Function SetFilterValuesAsync(
    values As Object(),
    filterType As FieldFilterType,
    showBlanks As Boolean,
    handler As AsyncCompletedHandler
) As Boolean

Parameters

Name Type Description
values Object[]

An object that represents a collection of field filter values.

filterType FieldFilterType

A FieldFilterType enumeration member that specifies the filter type.

showBlanks Boolean

True, to show blank values; otherwise, false.

handler AsyncCompletedHandler

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

Returns

Type Description
Boolean

True, if the field filter was applied; otherwise, false.

Remarks

The SetFilterValuesAsync method returns false if the field filter is already set to the parameter's values or if you cancel the filtering when handling the PivotGridControl.FieldFilterChanging event.

To add filter values to the collection in a standard mode, use the PivotGridField.SetFilterValues method.

See Also