PivotGridFieldFilterValues.ValuesExcluded Property

Gets or sets which values are excluded from the current field.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

public object[] ValuesExcluded { get; set; }
Public Property ValuesExcluded As Object()

Property Value

Type Description
Object[]

An array of the values that are excluded from being displayed in the current field.

Remarks

This property returns an array of the values that are not displayed for the current field by the XtraPivotGrid. To get the filter values use the PivotGridFieldFilterValues.Values property.

If an array of values is assigned to the ValuesExcluded property the current filter criteria will be reset and the XtraPivotGrid will then display all the field values for the current field excluding the values in the specified array. The following occurs in this case:

  1. the PivotGridFieldFilterValues.Values array is cleared
  2. values from the source array are copied to the PivotGridFieldFilterValues.Values array
  3. the PivotGridFieldFilterValues.FilterType property is set to PivotFilterType.Excluded.

If null is assigned the values in the PivotGridFieldFilterValues.Values array will be cleared. The result of the operation is dependant on the value of the PivotGridFieldFilterValues.FilterType property.

See Also