PivotGridFieldFilterValues.ValuesIncluded Property

Gets or sets the values that are displayed in the current field.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

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

Property Value

Type Description
Object[]

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

Remarks

This property returns an array of the values that are displayed in 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 ValuesIncluded property the current filter criteria will be reset and the XtraPivotGrid will then display the field values in this array for the current field. The other values will not be displayed. The following occur 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.Included.

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

See Also