PivotExcelFieldListControl Class

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

Declaration

C#
VB.NET

public class PivotExcelFieldListControl :
    FieldListControlBase

Public Class PivotExcelFieldListControl
    Inherits FieldListControlBase

Remarks

Customization Form is used to show, hide and reorder pivot grid fields, as well as move them between areas. To learn more, see Customization Form.

By default, the Customization Form is displayed in a separate window. Use the PivotExcelFieldListControl class to manually create a standalone Customization Form that can be located in the same window with PivotGridControl.

After the PivotExcelFieldListControl is created, you should specify a PivotGridControl that will own the Customization Form. To do this, assign the desired PivotGridControl instance to the ColumnChooserControlBase.Owner property.

pivotgrid_Excel2007CustomizationFrm

To create a simple-style Customization Form, use the PivotFieldListControl class.

Example

The following example demonstrates how to create a standalone Customization Form.

In this example, PivotExcelFieldListControl is created and bound to a Pivot Grid by assigning the PivotGridControl instance to the ColumnChooserControlBase.Owner property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-a-standalone-customization-form-e2980.

MainWindow.xaml

<Window xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
        x:Class="DXPivotGrid_StandaloneFieldList.MainWindow"
        Height="600" Width="900" Title="Main Window">
    <Grid x:Name="root">
        <Grid.ColumnDefinitions>
            <ColumnDefinition />
            <ColumnDefinition Width="250" />
        </Grid.ColumnDefinitions>
        <dxpg:PivotGridControl Name="pivotGridControl1" Grid.Column="0">
            <dxpg:PivotGridControl.Fields>
                <dxpg:PivotGridField Name="fieldCountry" FieldName="Country" Area="FilterArea"
                                     />
                <dxpg:PivotGridField Name="fieldUnitPrice" FieldName="UnitPrice" Area="FilterArea"
                                     />
                <dxpg:PivotGridField Name="fieldDiscount" FieldName="Discount" Area="FilterArea"
                                     />
                <dxpg:PivotGridField Name="fieldCustomer" FieldName="Sales Person" Area="RowArea"
                                     Caption="Customer" />
                <dxpg:PivotGridField Name="fieldYear" FieldName="OrderDate" Area="ColumnArea"
                                     Caption="Year" GroupInterval="DateYear" />
                <dxpg:PivotGridField Name="fieldMonth" FieldName="OrderDate" Area="ColumnArea"
                                     Caption="Month" GroupInterval="DateMonth" />
                <dxpg:PivotGridField Name="fieldCategoryName" FieldName="CategoryName" Area="RowArea"
                                     Caption="Category" />
                <dxpg:PivotGridField Name="fieldProductName" FieldName="ProductName" Area="FilterArea"
                                     Caption="Product" />
                <dxpg:PivotGridField Name="fieldQuantity" FieldName="Quantity" Area="DataArea" />
            </dxpg:PivotGridControl.Fields>
        </dxpg:PivotGridControl>
        <dxpg:PivotExcelFieldListControl Grid.Column="1" Owner="{Binding ElementName=pivotGridControl1}"
                                    Margin="5,5,5,5" />
    </Grid>
</Window>

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

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.

how-to-provide-the-search-functionality-in-pivotexcelfieldlistcontrol-customization-form-t165088/CS/WpfApplication3/MainWindow.xaml#L28

<Border Grid.Column="2" BorderThickness="1" BorderBrush="Black" CornerRadius="4" Background="{Binding ElementName=pivotGridControl1, Path=Background}">
    <dxpg:PivotExcelFieldListControl Name="pivotFieldList" Owner="{Binding ElementName=pivotGridControl1}" />

how-to-create-a-standalone-customization-form-e2980/VB/DXPivotGrid_StandaloneFieldList/MainWindow.xaml#L33

</dxpg:PivotGridControl>
<dxpg:PivotExcelFieldListControl Grid.Column="1" Owner="{Binding ElementName=pivotGridControl1}"
                            Margin="5,5,5,5" />