Class RadPivotFieldList

Represents a field list control for the RadPivotGrid that allows users to configure pivot grid fields by dragging and dropping them between different areas. The field list provides areas for report filters, row labels, column labels, and values, enabling interactive pivot grid configuration.

Inheritance
System.Object
RadPivotFieldList
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.PivotGrid.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadPivotFieldList : UserControl

Constructors

RadPivotFieldList()

Initializes a new instance of the RadPivotFieldList class.

Declaration
public RadPivotFieldList()

Properties

AssociatedPivotGrid

Gets or sets the RadPivotGrid control that this field list is associated with. Setting this property automatically associates the field list with the pivot grid's element, enabling bidirectional field configuration.

Declaration
public RadPivotGrid AssociatedPivotGrid { get; set; }
Property Value
RadPivotGrid

AssociatedPivotGridElement

Gets or sets the RadPivotGridElement that this field list is associated with. When set, the field list will reflect and control the field configuration of the associated pivot grid element.

Declaration
public RadPivotGridElement AssociatedPivotGridElement { get; set; }
Property Value
RadPivotGridElement

ColumnLabelsControl

Gets the RadListControl that displays and manages the column labels area of the pivot field list. Fields dropped into this area will become column headers in the pivot grid.

Declaration
public RadListControl ColumnLabelsControl { get; }
Property Value
RadListControl

DataProvider

Gets the data provider that supplies data to the associated pivot grid. This property returns the data provider from the associated RadPivotGridElement, or null if no pivot grid is associated.

Declaration
public IDataProvider DataProvider { get; }
Property Value
IDataProvider

DeferUpdates

Gets or sets a value indicating whether pivot grid updates should be deferred until explicitly executed. When true, field changes will not immediately update the pivot grid; instead, updates must be triggered manually.

Declaration
public bool DeferUpdates { get; set; }
Property Value
System.Boolean

DialogsFactory

Gets or sets the factory that creates dialogs for the pivot field list. This factory is responsible for creating various dialogs used in pivot grid operations.

Declaration
public PivotGridDialogsFactory DialogsFactory { get; set; }
Property Value
PivotGridDialogsFactory

DragDropService

Gets or sets the drag and drop service that handles field dragging operations within the pivot field list. This service manages the drag and drop behavior for moving fields between different areas.

Declaration
public PivotFieldListDragDropService DragDropService { get; set; }
Property Value
PivotFieldListDragDropService

FieldsControl

Gets the RadTreeView control that displays the available fields that can be dragged to different areas of the pivot field list. This tree view shows the hierarchical structure of fields from the data source.

Declaration
public RadTreeView FieldsControl { get; }
Property Value
RadTreeView

ReportFiltersControl

Gets the RadListControl that displays and manages the report filters area of the pivot field list. Fields dropped into this area will become filters that apply to the entire pivot grid.

Declaration
public RadListControl ReportFiltersControl { get; }
Property Value
RadListControl

RowLabelsControl

Gets the RadListControl that displays and manages the row labels area of the pivot field list. Fields dropped into this area will become row headers in the pivot grid.

Declaration
public RadListControl RowLabelsControl { get; }
Property Value
RadListControl

ThemeName

Gets or sets the theme name applied to the pivot field list and all its child controls. Setting this property will recursively apply the theme to all Telerik controls within the field list.

Declaration
public virtual string ThemeName { get; set; }
Property Value
System.String

ValuesControl

Gets the RadListControl that displays and manages the values area of the pivot field list. Fields dropped into this area will become aggregated values in the pivot grid cells.

Declaration
public RadListControl ValuesControl { get; }
Property Value
RadListControl

ViewModel

Gets the view model that manages the data and logic for the pivot field list. The view model contains the collections for different field areas and handles field operations.

Declaration
public FieldListViewModel ViewModel { get; }
Property Value
FieldListViewModel

Methods

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true if managed resources should be disposed; otherwise, false.

GetImageForRole(IField)

Gets the appropriate image icon for the specified field based on its role in the pivot structure. Different field roles (Dimension, Folder, Kpi, Measure, etc.) are represented by different icons.

Declaration
protected virtual Image GetImageForRole(IField field)
Parameters
IField field

The field for which to retrieve the role-specific image.
Returns
System.Drawing.Image

An System.Drawing.Image representing the field's role, or null if the field has no composite role or an unknown role.

InitializeText()

Initializes the localized text for all UI elements in the pivot field list using the current localization provider. This method should be called when the localization settings change or when the control is first created.

Declaration
public void InitializeText()

OnDataProviderChanged()

Called when the data provider changes. This method synchronizes the view model's data provider with the current data provider and notifies the view model of the change to refresh the field list accordingly.

Declaration
protected virtual void OnDataProviderChanged()

OnLoad(EventArgs)

Raises the System.Windows.Forms.UserControl.Load event and performs additional initialization based on the current theme. This method handles special positioning adjustments for Metro Touch and Material themes.

Declaration
protected override void OnLoad(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

UpdateFieldListsPosition()

Updates the position and size of the field list panels to distribute them evenly within the available space. This method calculates and sets the bounds for all four field areas (report filters, column labels, row labels, and values).

Declaration
protected virtual void UpdateFieldListsPosition()

Extension Methods