PivotGridFieldFilterValues.SetValues(IList<Object>, PivotFilterType, Boolean, Boolean) Method
Adds the specified values to the collection and sets the PivotGridFieldFilterValues.FilterType and PivotGridFieldFilterValues.ShowBlanks properties to the specified values.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.PivotGrid.v22.2.Core.dll
NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Dashboard.Design
Declaration
public bool SetValues(
IList<object> values,
PivotFilterType filterType,
bool showBlanks,
bool allowOnChanged
)Parameters
| Name | Type | Description |
|---|---|---|
| values | IList<Object> | An array of objects that contains filter values that should be added to the collection. |
| filterType | PivotFilterType | A PivotFilterType value that specifies the current field’s filter type. |
| showBlanks | Boolean | true if the PivotGridControl should process records that contain NULL values in the current field; otherwise, false. |
| allowOnChanged | Boolean | true to allow raising OnChanged events; otherwise, false. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the specified values differ from the current ones; otherwise, false. |
Remarks
This method clears the current collection, and adds objects passed in the values array to the collection. The PivotGridFieldFilterValues.FilterType and PivotGridFieldFilterValues.ShowBlanks properties are set to the specified values.
The PivotGridFieldFilterValues.FilterType property determines how filter values in the collection are handled. If it is set to PivotFilterType.Excluded, the PivotGridControl will not display records that contain filter values in the current field. All other records will be displayed. If the PivotGridFieldFilterValues.FilterType property is set to PivotFilterType.Included, the PivotGridControl will process only records that contain filter values in the current field. All other records will be ignored.
The PivotGridFieldFilterValues.ShowBlanks property specifies whether the PivotGridControl should process records that contain NULL values in the current field.
To add filter values to the collection asynchronously, use the PivotGridFieldFilterValues.SetValuesAsync method.