FieldFilterValues.SetValuesAsync(Object[], FieldFilterType, Boolean, AsyncCompletedHandler) Method

Adds the specified values to the collection and sets the FieldFilterValues.FilterType and PivotGridFieldFilterValues.ShowBlanks properties to the specified values asynchronously.

Namespace: DevExpress.Xpf.PivotGrid

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

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public bool SetValuesAsync(
    object[] values,
    FieldFilterType filterType,
    bool showBlanks,
    AsyncCompletedHandler handler
)

VB.NET

Public Function SetValuesAsync(
    values As Object(),
    filterType As FieldFilterType,
    showBlanks As Boolean,
    handler As AsyncCompletedHandler
) As Boolean

Parameters

Name	Type	Description
values	Object[]	An array of objects which represent the filter values to add to the collection.
filterType	FieldFilterType	A FieldFilterType value that specifies the current field’s filter type. This value is assigned to the FieldFilterValues.FilterType property.
showBlanks	Boolean	A Boolean value that specifies whether the PivotGrid should process the records which contain NULL values in the current field. This value is assigned to the PivotGridFieldFilterValues.ShowBlanks property.
handler	AsyncCompletedHandler	An AsyncCompletedHandler delegate referencing a method that should be executed after the operation is completed.

Returns

Type	Description
Boolean	true, if the field filter values have changed; otherwise, false.

Remarks

This method clears the current collection and then adds the objects passed in the values array to the collection asynchronously. The FieldFilterValues.FilterType and PivotGridFieldFilterValues.ShowBlanks properties are set to the specified values.

The FieldFilterValues.FilterType property determines how the filter values in the collection are handled. If it is set to FieldFilterType.Excluded, the PivotGrid control will not display the records which contain filter values in the current field. All other records will be displayed. If the FieldFilterValues.FilterType property is set to FieldFilterType.Included, the PivotGrid will process only the records which contain the filter values in the current field. All other records will be ignored.

The PivotGridFieldFilterValues.ShowBlanks property specifies whether the PivotGrid should process the records which contain NULL values in the current field.

To add the specified values to the collection synchronously, use the FieldFilterValues.SetValues method.