PivotGridFieldFilterValues.ValuesIncluded Property

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

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v18.2.Core.dll

Declaration

C#

public object[] ValuesIncluded { get; set; }

VB.NET

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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ValuesIncluded property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

keeping-a-checked-filter-item-displayed-when-records-are-removed-from-the-data-source-e2684/CS/XtraPivotGrid_S18746/Form1.cs#L21

pivotGridControl1.BeginUpdate();
fieldProductName.FilterValues.ValuesIncluded = new object[] { "Alice Mutton", "Aniseed Syrup" };
pivotGridControl1.EndUpdate();

how-to-define-a-custom-filter-popup-with-custom-toolbar-buttons-and-a-filter-editor-t357159/CS/CustomFilterPopup/CustomFilterPopup.cs#L72

var uniqueItems = PivotField.GetUniqueValues().Select(v => new PivotValueInfo() { Value = v, DisplayText = PivotField.GetDisplayText(v) }).ToArray();
var editValue = PivotField.FilterValues.ValuesIncluded;
Items.AddRange(uniqueItems);

how-to-create-a-custom-exporter-for-the-pivotgridcontrol-by-using-the-xtrareport-suite-this-e2231/CS/Report_at_Runtime/Form1.cs#L36

this.customerReportsTableAdapter.Fill(this.nwindDataSet.CustomerReports);
fieldProductName.FilterValues.ValuesIncluded = fieldProductName.GetUniqueValues().Take(7).ToArray();
pivotGridControl1.BestFit();

how-to-obtain-active-filter-criteria-applied-to-pivotgridcontrols-fields-e1999/CS/WindowsApplication1/MyPivotGridFilterHelper.cs#L42

outputDetail.Add(String.Format("Field '{0}'. Included values:", field.FieldName));
foreach (object value in field.FilterValues.ValuesIncluded) outputDetail.Add(String.Format("[ {0} ]", value));
outputDetail.Add(String.Format("Field '{0}'. Excluded values:", field.FieldName));

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/CS/E4669CS/CustomFieldFilterControl.cs#L72

object[] values = _field.GetUniqueValues();
object[] valuesIncluded = _field.FilterValues.ValuesIncluded;
filterItems = new BindingList<CustomFilterItem>();

VB.NET

keeping-a-checked-filter-item-displayed-when-records-are-removed-from-the-data-source-e2684/VB/XtraPivotGrid_S18746/Form1.vb#L23

pivotGridControl1.BeginUpdate()
fieldProductName.FilterValues.ValuesIncluded = New Object() { "Alice Mutton", "Aniseed Syrup" }
pivotGridControl1.EndUpdate()

how-to-define-a-custom-filter-popup-with-custom-toolbar-buttons-and-a-filter-editor-t357159/VB/CustomFilterPopup/CustomFilterPopup.vb#L82

Dim uniqueItems = PivotField.GetUniqueValues().Select(Function(v) New PivotValueInfo() With {.Value = v, .DisplayText = PivotField.GetDisplayText(v)}).ToArray()
Dim editValue = PivotField.FilterValues.ValuesIncluded
Items.AddRange(uniqueItems)

how-to-create-a-custom-exporter-for-the-pivotgridcontrol-by-using-the-xtrareport-suite-this-e2231/VB/Report_at_Runtime/Form1.vb#L33

Me.customerReportsTableAdapter.Fill(Me.nwindDataSet.CustomerReports)
fieldProductName.FilterValues.ValuesIncluded = fieldProductName.GetUniqueValues().Take(7).ToArray()
pivotGridControl1.BestFit()

how-to-obtain-active-filter-criteria-applied-to-pivotgridcontrols-fields-e1999/VB/WindowsApplication1/MyPivotGridFilterHelper.vb#L42

outputDetail.Add(String.Format("Field '{0}'. Included values:", field.FieldName))
For Each value As Object In field.FilterValues.ValuesIncluded
    outputDetail.Add(String.Format("[ {0} ]", value))

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/VB/CustomFieldFilterControl.vb#L71

Dim values() As Object = _field.GetUniqueValues()
Dim valuesIncluded() As Object = _field.FilterValues.ValuesIncluded
filterItems = New BindingList(Of CustomFilterItem)()