PivotGridField.GetVisibleValues() Method

Returns the field values currently shown in the PivotGrid.

Namespace: DevExpress.Xpf.PivotGrid

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.PivotGrid, DevExpress.Wpf.PivotGrid

Declaration

C#

public List<object> GetVisibleValues()

VB.NET

Public Function GetVisibleValues As List(Of Object)

Returns

Type	Description
List<Object>	A collection of objects that represent the field values currently shown in the PivotGrid.

Remarks

The resulting collection does not contain field values excluded from the PivotGrid’s layout, using the Field or Group Filter. To obtain all values stored in the underlying data source in the current field, use the PivotGridField.GetUniqueValues property.

Note

If the PivotGridControl filters data by OLAP member unique names (controlled by the PivotGridField.OlapFilterByUniqueName and PivotGridControl.OlapFilterByUniqueName options), the GetVisibleValues method returns them instead of field values.

Related GitHub Examples

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

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#

how-to-collapse-new-field-values-e3230/CS/WpfApplication52/MainWindow.xaml.cs#L79

if (field.Visible == false || field.Area == FieldArea.DataArea || field.Area == FieldArea.FilterArea) continue;
visibleValues[field] = new  List<object>(field.GetVisibleValues());

how-to-hide-filter-items-whose-corresponding-field-values-are-not-displayed-e2716/CS/DXPivotGrid_HowToHideFilterItems/MainWindow.xaml.cs#L12

private void pivotGridControl1_CustomFilterPopupItems(object sender, PivotCustomFilterPopupItemsEventArgs e) {
    List<object> values = e.Field.GetVisibleValues();
    values.Sort();

VB.NET

how-to-collapse-new-field-values-e3230/VB/WpfApplication52/MainWindow.xaml.vb#L76

End If
visibleValues(field) = New List(Of Object)(field.GetVisibleValues())

how-to-hide-filter-items-whose-corresponding-field-values-are-not-displayed-e2716/VB/DXPivotGrid_HowToHideFilterItems/MainWindow.xaml.vb#L16

Private Sub pivotGridControl1_CustomFilterPopupItems(ByVal sender As Object, ByVal e As PivotCustomFilterPopupItemsEventArgs)
    Dim values As List(Of Object) = e.Field.GetVisibleValues()
    values.Sort()